[REPOST PATCH v2 1/3] Documentation: dt-bindings: Add snps,need-phy-for-wake for dwc2 USB

From: Douglas Anderson
Date: Thu May 16 2019 - 19:02:09 EST


Some SoCs with a dwc2 USB controller may need to keep the PHY on to
support remote wakeup. Allow specifying this as a device tree
property.

Signed-off-by: Douglas Anderson <dianders@xxxxxxxxxxxx>
---
For relevant prior discussion on this patch, see:

https://lkml.kernel.org/r/1435017144-2971-3-git-send-email-dianders@xxxxxxxxxxxx

I didn't make any changes from the prior version since I never found
out what Rob thought of my previous arguments. If folks want a
change, perhaps they could choose from these options:

1. Assume that all dwc2 hosts would like to keep their PHY on for
suspend if there's a USB wakeup enabled, thus we totally drop this
binding. This doesn't seem super great to me since I'd bet that
many devices that use dwc2 weren't designed for USB wakeup (they
may not keep enough clocks or rails on) so we might be wasting
power for nothing.
2. Rename this property to "snps,wakeup-from-suspend-with-phy" to make
it more obvious that this property is intended both to document
that wakeup from suspend is possible and that we need the PHY for
said wakeup.
3. Rename this property to "snps,can-wakeup-from-suspend" and assume
it's implicit that if we can wakeup from suspend that we need to
keep the PHY on. If/when someone shows that a device exists using
dwc2 where we can wakeup from suspend without the PHY they can add
a new property.

NOTE FOR REPOST:
- In v2 Rob said [1] he'd prefer something based on the SoC
compatibility string, but that doesn't work because not all boards
will have the regulator setup / board design / suspend logic
necessary to make this work.

[1] https://lkml.kernel.org/r/20190430012328.GA25660@bogus


Changes in v2: None

Documentation/devicetree/bindings/usb/dwc2.txt | 3 +++
1 file changed, 3 insertions(+)

diff --git a/Documentation/devicetree/bindings/usb/dwc2.txt b/Documentation/devicetree/bindings/usb/dwc2.txt
index 49eac0dc86b0..aafff3a6904d 100644
--- a/Documentation/devicetree/bindings/usb/dwc2.txt
+++ b/Documentation/devicetree/bindings/usb/dwc2.txt
@@ -42,6 +42,8 @@ Refer to phy/phy-bindings.txt for generic phy consumer properties
- g-rx-fifo-size: size of rx fifo size in gadget mode.
- g-np-tx-fifo-size: size of non-periodic tx fifo size in gadget mode.
- g-tx-fifo-size: size of periodic tx fifo per endpoint (except ep0) in gadget mode.
+- snps,need-phy-for-wake: If present indicates that the phy needs to be left
+ on for remote wakeup during suspend.
- snps,reset-phy-on-wake: If present indicates that we need to reset the PHY when
we detect a wakeup. This is due to a hardware errata.

@@ -58,4 +60,5 @@ Example:
clock-names = "otg";
phys = <&usbphy>;
phy-names = "usb2-phy";
+ snps,need-phy-for-wake;
};
--
2.21.0.1020.gf2820cf01a-goog