Skip to contentSkip to conversation

usbip: Remove repeated setting of hcd->state in vhci_bus_suspend()

PATCH In review Suwan Kim 2 participants 7 messages May 6, 2019 – May 14, 2019

Subsystems (2)
lore
Share & tools
lore

Suwan Kim

author
#0 lore raw

PATCH 1/2 usbip: Remove repeated setting of hcd->state in vhci_bus_suspend()

When hcd suspends execution, hcd_bus_suspend() calls vhci_bus_suspend() which sets hcd->state as HC_STATE_SUSPENDED. But after calling vhci_bus_suspend(), hcd_bus_suspend() also sets hcd->state as HC_STATE_SUSPENDED.
So, setting hcd->state in vhci_hcd_suspend() is unnecessary.

---
 drivers/usb/usbip/vhci_hcd.c | 4 ----
 1 file changed, 4 deletions(-)
drivers/usb/usbip/vhci_hcd.c +0 -4
index 667d9c0ec905..e6f378d00fb6 100644
@@ -1238,10 +1238,6 @@ static int vhci_bus_suspend(struct usb_hcd *hcd)
 
 	dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
 
-	spin_lock_irqsave(&vhci->lock, flags);
-	hcd->state = HC_STATE_SUSPENDED;
-	spin_unlock_irqrestore(&vhci->lock, flags);
-
 	return 0;
 }
 
Signature · 1 line
2.20.1
author
#1 lore raw

PATCH 2/2 usbip: Remove repeated setting of hcd->state in vhci_bus_resume()

When hcd resumes, hcd_bus_resume() calls vhci_bus_resume() which sets hcd->state as HC_STATE_RUNNING. But after calling vhci_bus_resume(), hcd_bus_resume() also sets hcd->state as HC_STATE_RUNNING. So, setting hcd->state in vhci_hcd_resume() is unnecessary.

---
 drivers/usb/usbip/vhci_hcd.c | 2 --
 1 file changed, 2 deletions(-)
drivers/usb/usbip/vhci_hcd.c +0 -2
index e6f378d00fb6..335d61676fb4 100644
@@ -1252,8 +1252,6 @@ static int vhci_bus_resume(struct usb_hcd *hcd)
 	spin_lock_irqsave(&vhci->lock, flags);
 	if (!HCD_HW_ACCESSIBLE(hcd))
 		rc = -ESHUTDOWN;
-	else
-		hcd->state = HC_STATE_RUNNING;
 	spin_unlock_irqrestore(&vhci->lock, flags);
 
 	return rc;
Signature · 1 line
2.20.1
maintainer
#2 lore raw

Re: [PATCH 2/2] usbip: Remove repeated setting of hcd->state in vhci_bus_resume()

Quoted 16 lines · Suwan Kim

When hcd resumes, hcd_bus_resume() calls vhci_bus_resume() which sets hcd->state as HC_STATE_RUNNING. But after calling vhci_bus_resume(), hcd_bus_resume() also sets hcd->state as HC_STATE_RUNNING. So, setting hcd->state in vhci_hcd_resume() is unnecessary.

---
  drivers/usb/usbip/vhci_hcd.c | 2 --
  1 file changed, 2 deletions(-)
drivers/usb/usbip/vhci_hcd.c +0 -0
index e6f378d00fb6..335d61676fb4 100644

drivers/usb/usbip/vhci_hcd.c static int vhci_bus_resume(struct usb_hcd *hcd) · line 1257

Quoted 8 lines
drivers/usb/usbip/vhci_hcd.c +0 -2
@@ -1252,8 +1252,6 @@ static int vhci_bus_resume(struct usb_hcd *hcd)
  	spin_lock_irqsave(&vhci->lock, flags);
  	if (!HCD_HW_ACCESSIBLE(hcd))
  		rc = -ESHUTDOWN;
-	else
-		hcd->state = HC_STATE_RUNNING;
  	spin_unlock_irqrestore(&vhci->lock, flags);
 
  	return rc;

Tell me more about why you think this change is needed? How did you test this change?

thanks,
-- Shuah

maintainer
#3 lore raw
In reply to Suwan Kim
Quoted 17 lines · Suwan Kim

When hcd suspends execution, hcd_bus_suspend() calls vhci_bus_suspend() which sets hcd->state as HC_STATE_SUSPENDED. But after calling vhci_bus_suspend(), hcd_bus_suspend() also sets hcd->state as HC_STATE_SUSPENDED.
So, setting hcd->state in vhci_hcd_suspend() is unnecessary.

---
  drivers/usb/usbip/vhci_hcd.c | 4 ----
  1 file changed, 4 deletions(-)
drivers/usb/usbip/vhci_hcd.c +0 -0
index 667d9c0ec905..e6f378d00fb6 100644

drivers/usb/usbip/vhci_hcd.c static int vhci_bus_suspend(struct usb_hcd *hcd) · line 1243

Quoted 10 lines
drivers/usb/usbip/vhci_hcd.c +0 -4
@@ -1238,10 +1238,6 @@ static int vhci_bus_suspend(struct usb_hcd *hcd)
 
  	dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
 
-	spin_lock_irqsave(&vhci->lock, flags);
-	hcd->state = HC_STATE_SUSPENDED;
-	spin_unlock_irqrestore(&vhci->lock, flags);
-
  	return 0;
  }
 

Tell me more about why you think this change is needed? How did you test this change?

thanks,
-- Shuah

author
#4 lore raw

Hi Shuah,

Quoted 12 lines · shuah
Quoted 11 lines · Suwan Kim

When hcd suspends execution, hcd_bus_suspend() calls vhci_bus_suspend() which sets hcd->state as HC_STATE_SUSPENDED. But after calling vhci_bus_suspend(), hcd_bus_suspend() also sets hcd->state as HC_STATE_SUSPENDED.
So, setting hcd->state in vhci_hcd_suspend() is unnecessary.

---
  drivers/usb/usbip/vhci_hcd.c | 4 ----
  1 file changed, 4 deletions(-)
Quoted 16 lines

drivers/usb/usbip/vhci_hcd.c static int vhci_bus_suspend(struct usb_hcd *hcd) · line 1241

Quoted 13 lines
drivers/usb/usbip/vhci_hcd.c +0 -4
index 667d9c0ec905..e6f378d00fb6 100644
@@ -1238,10 +1238,6 @@ static int vhci_bus_suspend(struct usb_hcd *hcd)
  	dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
-	spin_lock_irqsave(&vhci->lock, flags);
-	hcd->state = HC_STATE_SUSPENDED;
-	spin_unlock_irqrestore(&vhci->lock, flags);
-
  	return 0;
  }
 

Tell me more about why you think this change is needed? How did you test this change?

I think that host controller specific functions, vhci_bus_resume() or vhci_bus_suspend() in the case of vhci, usually process host controller specific data (struct vhci_hcd) not a generic data (struct usb_hcd). The generic data is usually processed by generic HCD layer. But vhci_bus_resume() and vhci_bus_suspend() set generic data (hcd->state) and moreover this variable is set in generic HCD layer once again(hcd_bus_resume() and hcd_bus_suspend()).

So, i think host controller specific functions (vhci_bus_resume() and vhci_bus_suspend()) don't need to set the generic data that is "hcd->state = HC_STATE_RUNNING or HC_STATE_SUSPEND".

For test, I loaded vhci-hcd module, suspended and resumed my computer and checked hcd->state variable. There is no difference compared with not modified version because my patch just removes repeated and unnecessary part.

Regards

Suwan Kim

maintainer
#5 lore raw
Quoted 40 lines · Suwan Kim

Hi Shuah,

Quoted 12 lines · shuah
Quoted 11 lines · Suwan Kim

When hcd suspends execution, hcd_bus_suspend() calls vhci_bus_suspend() which sets hcd->state as HC_STATE_SUSPENDED. But after calling vhci_bus_suspend(), hcd_bus_suspend() also sets hcd->state as HC_STATE_SUSPENDED.
So, setting hcd->state in vhci_hcd_suspend() is unnecessary.

---
   drivers/usb/usbip/vhci_hcd.c | 4 ----
   1 file changed, 4 deletions(-)
Quoted 16 lines

drivers/usb/usbip/vhci_hcd.c static int vhci_bus_suspend(struct usb_hcd *hcd) · line 1241

Quoted 13 lines
drivers/usb/usbip/vhci_hcd.c +0 -4
index 667d9c0ec905..e6f378d00fb6 100644
@@ -1238,10 +1238,6 @@ static int vhci_bus_suspend(struct usb_hcd *hcd)
   	dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
-	spin_lock_irqsave(&vhci->lock, flags);
-	hcd->state = HC_STATE_SUSPENDED;
-	spin_unlock_irqrestore(&vhci->lock, flags);
-
   	return 0;
   }
 

Tell me more about why you think this change is needed? How did you test this change?

I think that host controller specific functions, vhci_bus_resume() or vhci_bus_suspend() in the case of vhci, usually process host controller specific data (struct vhci_hcd) not a generic data (struct usb_hcd). The generic data is usually processed by generic HCD layer. But vhci_bus_resume() and vhci_bus_suspend() set generic data (hcd->state) and moreover this variable is set in generic HCD layer once again(hcd_bus_resume() and hcd_bus_suspend()).

Quoted 4 lines

So, i think host controller specific functions (vhci_bus_resume() and vhci_bus_suspend()) don't need to set the generic data that is "hcd->state = HC_STATE_RUNNING or HC_STATE_SUSPEND".

It depends. In this case, vhci_hcd is virtual driver and maintains port status for devices that are remote. It checks hcd->state in vhci_hub_status().

It updates the hcd->state in suspend with vhci->lock hold and checks
status from vhci_hub_status(). Removing updating hcd->state from vhci_bus_suspend()will open a window where vhci_hub_status() might find it wrong state.

Same thing for HC_STATE_RUNNING. There are few other drivers that do the same for similar reasons. xhci_hcd, and dummy_hcd and a few more. This is the same comment on your patch that removes HC_STATE_RUNNING update from resume.

Quoted 5 lines

For test, I loaded vhci-hcd module, suspended and resumed my computer and checked hcd->state variable. There is no difference compared with not modified version because my patch just removes repeated and unnecessary part.

This won't fully test the condition since there are remote devices attached and triggering suspend while attach/detach is in progress.

thanks,
-- Shuah

author
#6 lore raw
Quoted 46 lines · shuah
Quoted 40 lines · Suwan Kim

Hi Shuah,

Quoted 12 lines · shuah
Quoted 11 lines · Suwan Kim

When hcd suspends execution, hcd_bus_suspend() calls vhci_bus_suspend() which sets hcd->state as HC_STATE_SUSPENDED. But after calling vhci_bus_suspend(), hcd_bus_suspend() also sets hcd->state as HC_STATE_SUSPENDED.
So, setting hcd->state in vhci_hcd_suspend() is unnecessary.

---
   drivers/usb/usbip/vhci_hcd.c | 4 ----
   1 file changed, 4 deletions(-)
Quoted 16 lines

drivers/usb/usbip/vhci_hcd.c static int vhci_bus_suspend(struct usb_hcd *hcd) · line 1241

Quoted 13 lines
drivers/usb/usbip/vhci_hcd.c +0 -4
index 667d9c0ec905..e6f378d00fb6 100644
@@ -1238,10 +1238,6 @@ static int vhci_bus_suspend(struct usb_hcd *hcd)
   	dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
-	spin_lock_irqsave(&vhci->lock, flags);
-	hcd->state = HC_STATE_SUSPENDED;
-	spin_unlock_irqrestore(&vhci->lock, flags);
-
   	return 0;
   }
 

Tell me more about why you think this change is needed? How did you test this change?

I think that host controller specific functions, vhci_bus_resume() or vhci_bus_suspend() in the case of vhci, usually process host controller specific data (struct vhci_hcd) not a generic data (struct usb_hcd). The generic data is usually processed by generic HCD layer. But vhci_bus_resume() and vhci_bus_suspend() set generic data (hcd->state) and moreover this variable is set in generic HCD layer once again(hcd_bus_resume() and hcd_bus_suspend()).

Quoted 4 lines

So, i think host controller specific functions (vhci_bus_resume() and vhci_bus_suspend()) don't need to set the generic data that is "hcd->state = HC_STATE_RUNNING or HC_STATE_SUSPEND".

Quoted 9 lines

It depends. In this case, vhci_hcd is virtual driver and maintains port status for devices that are remote. It checks hcd->state in vhci_hub_status().

It updates the hcd->state in suspend with vhci->lock hold and checks status from vhci_hub_status(). Removing updating hcd->state from vhci_bus_suspend()will open a window where vhci_hub_status() might find it wrong state.

I didn't know that and I missed. Thank you for pointing out my fault. I agree that removing updating hcd->state which is protected by vhci lock is not correct.

But I still have not fully understood the relationship between vhci_bus_suspend() and vhci_hub_status() yet. I will look at it in more detail. Again, thank you for reviewing my patch.

Regards

Suwan Kim