usb: hub: Clear Port Reset Change during init/resume
PATCH 1/1 usb: hub: Clear Port Reset Change during init/resume
This patch adds the Port Reset Change flag to the set of bits that are preemptively cleared on init/resume of a hub. In theory this bit should never be set unexpectedly... in practice it can still happen if BIOS, SMM or ACPI code plays around with USB devices without cleaning up correctly. This is especially dangerous for XHCI root hubs, which don't generate any more Port Status Change Events until all change bits are cleared, so this is a good precaution to have (similar to how it's already done for the Warm Port Reset Change flag).
--- drivers/usb/core/hub.c | 5 +++++ 1 file changed, 5 insertions(+)
drivers/usb/core/hub.c +5 -0
@@ -1130,6 +1130,11 @@ static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)usb_clear_port_feature (hub->hdev, port1,USB_PORT_FEAT_C_ENABLE ); } +if ((portchange &USB_PORT_STAT_C_RESET )) { + need_debounce_delay = true; +usb_clear_port_feature (hub->hdev, port1, +USB_PORT_FEAT_C_RESET ); + }if ((portchange &USB_PORT_STAT_C_BH_RESET ) &&hub_is_superspeed (hub->hdev)) { need_debounce_delay = true;
Signature · 1 line
1.7.12.4
Hello.
Quoted 19 lines · Julius Werner
This patch adds the Port Reset Change flag to the set of bits that are preemptively cleared on init/resume of a hub. In theory this bit should never be set unexpectedly... in practice it can still happen if BIOS, SMM or ACPI code plays around with USB devices without cleaning up correctly. This is especially dangerous for XHCI root hubs, which don't generate any more Port Status Change Events until all change bits are cleared, so this is a good precaution to have (similar to how it's already done for the Warm Port Reset Change flag).
Signed-off-by Julius Werner <[email protected]>--- drivers/usb/core/hub.c | 5 +++++ 1 file changed, 5 insertions(+)drivers/usb/core/hub.c +0
-0
drivers/usb/core/hub.c static void hub_activate(struct usb_hub *hub, enum hub_activation_type type) · line 1133
Quoted 4 lines
drivers/usb/core/hub.c +1
-0@@ -1130,6 +1130,11 @@ static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)usb_clear_port_feature (hub->hdev, port1,USB_PORT_FEAT_C_ENABLE ); } +if ((portchange &USB_PORT_STAT_C_RESET )) {
Hm, why these double parens?
WBR, Sergei
Quoted 4 lines
Quoted 1 line
+ if ((portchange &
USB_PORT_STAT_C_RESET)) {Hm, why these double parens?
Oh... good question. I copied the entry below it, remove the && and must have overlooked those. Sorry, v2 incoming...
PATCH v2 1/1 usb: hub: Clear Port Reset Change during init/resume
This patch adds the Port Reset Change flag to the set of bits that are preemptively cleared on init/resume of a hub. In theory this bit should never be set unexpectedly... in practice it can still happen if BIOS, SMM or ACPI code plays around with USB devices without cleaning up correctly. This is especially dangerous for XHCI root hubs, which don't generate any more Port Status Change Events until all change bits are cleared, so this is a good precaution to have (similar to how it's already done for the Warm Port Reset Change flag).
--- drivers/usb/core/hub.c | 5 +++++ 1 file changed, 5 insertions(+)
drivers/usb/core/hub.c +5 -0
@@ -1130,6 +1130,11 @@ static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)usb_clear_port_feature (hub->hdev, port1,USB_PORT_FEAT_C_ENABLE ); } +if (portchange &USB_PORT_STAT_C_RESET ) { + need_debounce_delay = true; +usb_clear_port_feature (hub->hdev, port1, +USB_PORT_FEAT_C_RESET ); + }if ((portchange &USB_PORT_STAT_C_BH_RESET ) &&hub_is_superspeed (hub->hdev)) { need_debounce_delay = true;
Signature · 1 line
1.7.12.4
Quoted 20 lines · Julius Werner
This patch adds the Port Reset Change flag to the set of bits that are preemptively cleared on init/resume of a hub. In theory this bit should never be set unexpectedly... in practice it can still happen if BIOS, SMM or ACPI code plays around with USB devices without cleaning up correctly. This is especially dangerous for XHCI root hubs, which don't generate any more Port Status Change Events until all change bits are cleared, so this is a good precaution to have (similar to how it's already done for the Warm Port Reset Change flag).
Signed-off-by Julius Werner <[email protected]>--- drivers/usb/core/hub.c | 5 +++++ 1 file changed, 5 insertions(+)drivers/usb/core/hub.c +0
-0@@ -1130,6 +1130,11 @@ static void hub_activate(struct usb_hub *hub, enum hub_activation_type type) usb_clear_port_feature(hub->hdev, port1,
drivers/usb/core/hub.c static void hub_activate(struct usb_hub *hub, enum hub_activation_type type) · line 1140
Quoted 10 lines
drivers/usb/core/hub.c +5
-0USB_PORT_FEAT_C_ENABLE); } +if (portchange &USB_PORT_STAT_C_RESET ) { + need_debounce_delay = true; +usb_clear_port_feature (hub->hdev, port1, +USB_PORT_FEAT_C_RESET ); + }if ((portchange &USB_PORT_STAT_C_BH_RESET ) &&hub_is_superspeed (hub->hdev)) { need_debounce_delay = true;
Quoted 8 lines · Julius Werner
This patch adds the Port Reset Change flag to the set of bits that are preemptively cleared on init/resume of a hub. In theory this bit should never be set unexpectedly... in practice it can still happen if BIOS, SMM or ACPI code plays around with USB devices without cleaning up correctly. This is especially dangerous for XHCI root hubs, which don't generate any more Port Status Change Events until all change bits are cleared, so this is a good precaution to have (similar to how it's already done for the Warm Port Reset Change flag).
Did you run into an issue where port status change events weren't being generated because the Port Reset flag was set? I'm trying to figure out if this addresses a real issue you hit (and thus should be queued for stable), or if this is just a precaution.
I do agree this is a good fix. ISTR that with some xHCI vendors, when the host is reset, the hardware will drive a port reset down all ports. That may cause the port reset and even warm port reset bits to be set. I have a vague recollection that some implementations might not even wait for the port reset to complete before saying the reset is done. We can't tell which hosts will and won't drive a reset, so we rely on the USB core to clear those bits if they are set.
So perhaps instead of the BIOS/SMM/ACPI code leaving the ports in an unclean state, the root cause of your issue is actually the call to xhci_reset? You can check the port status before that call to find out.
Quoted 24 lines
Signed-off-by Julius Werner <[email protected]>--- drivers/usb/core/hub.c | 5 +++++ 1 file changed, 5 insertions(+)drivers/usb/core/hub.c +5
-0@@ -1130,6 +1130,11 @@ static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)usb_clear_port_feature (hub->hdev, port1,USB_PORT_FEAT_C_ENABLE ); } +if (portchange &USB_PORT_STAT_C_RESET ) { + need_debounce_delay = true; +usb_clear_port_feature (hub->hdev, port1, +USB_PORT_FEAT_C_RESET ); + }if ((portchange &USB_PORT_STAT_C_BH_RESET ) &&hub_is_superspeed (hub->hdev)) { need_debounce_delay = true;Signature · 1 line
1.7.12.4
Quoted 5 lines · Sarah Sharp
Did you run into an issue where port status change events weren't being generated because the Port Reset flag was set? I'm trying to figure out if this addresses a real issue you hit (and thus should be queued for stable), or if this is just a precaution.
We ran into this on HP Chromebook 14 (Falco). The port reset flag would be set after a suspend/resume cycle with nothing attached.
Signature · 3 lines
Benson Leung Software Engineer, Chrom* OS [email protected]
Quoted 4 lines
Did you run into an issue where port status change events weren't being generated because the Port Reset flag was set? I'm trying to figure out if this addresses a real issue you hit (and thus should be queued for stable), or if this is just a precaution.
As Benson said, we're seeing this on the HP Chromebook 14 (Intel LynxPoint xHC). It only happens after system suspend/resume, so I'm not sure if there even is an xHC reset involved (not by the kernel anyway, but with all that other stuff it's hard to say). Note that we build our own firmware (including SMM/ACPI handlers), so this does not directly translate to LynxPoint PCs, but I think we based some of our code off Intel reference code and guides which may have already included the problem. I've found port reset code in both our firmware resume path and ACPI _PS0 handler, but they both seem to clear all Port Change bits correctly, so we are not sure about our true root cause yet.