[v6] usb: common: usb-conn-gpio: Set last role to unknown before initial detection

Message ID 1685421871-25391-1-git-send-email-quic_prashk@quicinc.com
State New
Headers
Series [v6] usb: common: usb-conn-gpio: Set last role to unknown before initial detection |

Commit Message

Prashanth K May 30, 2023, 4:44 a.m. UTC
  Currently if we bootup a device without cable connected, then
usb-conn-gpio won't call set_role() since last_role is same as
current role. This happens because during probe last_role gets
initialised to zero.

To avoid this, added a new constant in enum usb_role, last_role
is set to USB_ROLE_UNKNOWN before performing initial detection.

While at it, also handle default case for the usb_role switch
in cdns3 to avoid build warnings.

Fixes: 4602f3bff266 ("usb: common: add USB GPIO based connection detection driver")
Signed-off-by: Prashanth K <quic_prashk@quicinc.com>
---
v6: Moved USB_ROLE_UNKNOWN towards the end of enum usb_role.
v5: Update commit text to mention the changes made in cdns3 driver.
v4: Added Reviewed-by tag.
v3: Added a default case in drivers/usb/cdns3/core.c as pointed out by
    the test robot.
v2: Added USB_ROLE_UNKNWON to enum usb_role.

 drivers/usb/cdns3/core.c           | 2 ++
 drivers/usb/common/usb-conn-gpio.c | 3 +++
 include/linux/usb/role.h           | 1 +
 3 files changed, 6 insertions(+)
  

Comments

AngeloGioacchino Del Regno May 30, 2023, 7:09 a.m. UTC | #1
Il 30/05/23 06:44, Prashanth K ha scritto:
> Currently if we bootup a device without cable connected, then
> usb-conn-gpio won't call set_role() since last_role is same as
> current role. This happens because during probe last_role gets
> initialised to zero.
> 
> To avoid this, added a new constant in enum usb_role, last_role
> is set to USB_ROLE_UNKNOWN before performing initial detection.
> 
> While at it, also handle default case for the usb_role switch
> in cdns3 to avoid build warnings.
> 
> Fixes: 4602f3bff266 ("usb: common: add USB GPIO based connection detection driver")
> Signed-off-by: Prashanth K <quic_prashk@quicinc.com>

Reviewed-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
  
Greg KH May 30, 2023, 2:28 p.m. UTC | #2
On Tue, May 30, 2023 at 10:14:31AM +0530, Prashanth K wrote:
> Currently if we bootup a device without cable connected, then
> usb-conn-gpio won't call set_role() since last_role is same as
> current role. This happens because during probe last_role gets
> initialised to zero.
> 
> To avoid this, added a new constant in enum usb_role, last_role
> is set to USB_ROLE_UNKNOWN before performing initial detection.
> 
> While at it, also handle default case for the usb_role switch
> in cdns3 to avoid build warnings.
> 
> Fixes: 4602f3bff266 ("usb: common: add USB GPIO based connection detection driver")
> Signed-off-by: Prashanth K <quic_prashk@quicinc.com>

Breaks the build :(

Please be more careful when submitting stuff, especially on v6 of a
patch :(
  
Prashanth K May 30, 2023, 3:26 p.m. UTC | #3
On 30-05-23 07:58 pm, Greg Kroah-Hartman wrote:
> On Tue, May 30, 2023 at 10:14:31AM +0530, Prashanth K wrote:
>> Currently if we bootup a device without cable connected, then
>> usb-conn-gpio won't call set_role() since last_role is same as
>> current role. This happens because during probe last_role gets
>> initialised to zero.
>>
>> To avoid this, added a new constant in enum usb_role, last_role
>> is set to USB_ROLE_UNKNOWN before performing initial detection.
>>
>> While at it, also handle default case for the usb_role switch
>> in cdns3 to avoid build warnings.
>>
>> Fixes: 4602f3bff266 ("usb: common: add USB GPIO based connection detection driver")
>> Signed-off-by: Prashanth K <quic_prashk@quicinc.com>
> 
> Breaks the build :(
> 
> Please be more careful when submitting stuff, especially on v6 of a
> patch :(

Hi, sorry for the trouble, I didn't see any issue in while building 
locally nor any warning/errors from test robot. Can you please point me 
to the error report if available. If the build is breaking due to enum 
value USB_ROLE_UNKNOWN unhandled in switch cases of other drivers, then 
i will revert thing back to v1 where i used a macro for USB_ROLE_UNKNOWN 
in usb-conn-gpio driver. Something like this in usb-conn-gpio.c would 
can help us avoid adding default case in other drivers using usb_role.

#define USB_ROLE_UNKNWON (USB_ROLE_NONE - 1)

Please let me know.

Thanks,
Prashanth K
  
Greg KH May 30, 2023, 4:43 p.m. UTC | #4
On Tue, May 30, 2023 at 08:56:26PM +0530, Prashanth K wrote:
> 
> 
> On 30-05-23 07:58 pm, Greg Kroah-Hartman wrote:
> > On Tue, May 30, 2023 at 10:14:31AM +0530, Prashanth K wrote:
> > > Currently if we bootup a device without cable connected, then
> > > usb-conn-gpio won't call set_role() since last_role is same as
> > > current role. This happens because during probe last_role gets
> > > initialised to zero.
> > > 
> > > To avoid this, added a new constant in enum usb_role, last_role
> > > is set to USB_ROLE_UNKNOWN before performing initial detection.
> > > 
> > > While at it, also handle default case for the usb_role switch
> > > in cdns3 to avoid build warnings.
> > > 
> > > Fixes: 4602f3bff266 ("usb: common: add USB GPIO based connection detection driver")
> > > Signed-off-by: Prashanth K <quic_prashk@quicinc.com>
> > 
> > Breaks the build :(
> > 
> > Please be more careful when submitting stuff, especially on v6 of a
> > patch :(
> 
> Hi, sorry for the trouble, I didn't see any issue in while building locally
> nor any warning/errors from test robot. Can you please point me to the error
> report if available. If the build is breaking due to enum value
> USB_ROLE_UNKNOWN unhandled in switch cases of other drivers, then i will
> revert thing back to v1 where i used a macro for USB_ROLE_UNKNOWN in
> usb-conn-gpio driver. Something like this in usb-conn-gpio.c would can help
> us avoid adding default case in other drivers using usb_role.
> 
> #define USB_ROLE_UNKNWON (USB_ROLE_NONE - 1)

Just fix up the drivers that need it at the same time:

  CC [M]  drivers/usb/roles/intel-xhci-usb-role-switch.o
drivers/usb/roles/intel-xhci-usb-role-switch.c: In function ‘intel_xhci_usb_set_role’:
drivers/usb/roles/intel-xhci-usb-role-switch.c:84:9: error: enumeration value ‘USB_ROLE_UNKNOWN’ not handled in switch [-Werror=switch]
   84 |         switch (role) {
      |         ^~~~~~
cc1: all warnings being treated as errors

thanks,

greg k-h
  

Patch

diff --git a/drivers/usb/cdns3/core.c b/drivers/usb/cdns3/core.c
index dbcdf3b..69d2921 100644
--- a/drivers/usb/cdns3/core.c
+++ b/drivers/usb/cdns3/core.c
@@ -252,6 +252,8 @@  static enum usb_role cdns_hw_role_state_machine(struct cdns *cdns)
 		if (!vbus)
 			role = USB_ROLE_NONE;
 		break;
+	default:
+		break;
 	}
 
 	dev_dbg(cdns->dev, "role %d -> %d\n", cdns->role, role);
diff --git a/drivers/usb/common/usb-conn-gpio.c b/drivers/usb/common/usb-conn-gpio.c
index e20874c..30bdb81 100644
--- a/drivers/usb/common/usb-conn-gpio.c
+++ b/drivers/usb/common/usb-conn-gpio.c
@@ -257,6 +257,9 @@  static int usb_conn_probe(struct platform_device *pdev)
 	platform_set_drvdata(pdev, info);
 	device_set_wakeup_capable(&pdev->dev, true);
 
+	/* Set last role to unknown before performing the initial detection */
+	info->last_role = USB_ROLE_UNKNOWN;
+
 	/* Perform initial detection */
 	usb_conn_queue_dwork(info, 0);
 
diff --git a/include/linux/usb/role.h b/include/linux/usb/role.h
index b5deafd..65e790a 100644
--- a/include/linux/usb/role.h
+++ b/include/linux/usb/role.h
@@ -11,6 +11,7 @@  enum usb_role {
 	USB_ROLE_NONE,
 	USB_ROLE_HOST,
 	USB_ROLE_DEVICE,
+	USB_ROLE_UNKNOWN,
 };
 
 typedef int (*usb_role_switch_set_t)(struct usb_role_switch *sw,