2021-02-23 20:11:21

by Álvaro Fernández Rojas

[permalink] [raw]
Subject: [PATCH 1/2] dt-bindings: usb: generic-ehci: document ignore-oc flag

Over-current reporting isn't supported on some platforms such as bcm63xx.
These devices will incorrectly report over-current if this flag isn't properly
activated.

Signed-off-by: Álvaro Fernández Rojas <[email protected]>
---
Documentation/devicetree/bindings/usb/generic-ehci.yaml | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/Documentation/devicetree/bindings/usb/generic-ehci.yaml b/Documentation/devicetree/bindings/usb/generic-ehci.yaml
index cf83f2d9afac..294bbf02399e 100644
--- a/Documentation/devicetree/bindings/usb/generic-ehci.yaml
+++ b/Documentation/devicetree/bindings/usb/generic-ehci.yaml
@@ -117,6 +117,11 @@ properties:
Set this flag if EHCI has a Transaction Translator built into
the root hub.

+ ignore-oc:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description:
+ Set this flag for HCDs without over-current reporting support.
+
needs-reset-on-resume:
$ref: /schemas/types.yaml#/definitions/flag
description:
--
2.20.1


2021-02-23 20:19:31

by Alan Stern

[permalink] [raw]
Subject: Re: [PATCH 1/2] dt-bindings: usb: generic-ehci: document ignore-oc flag

On Tue, Feb 23, 2021 at 05:04:57PM +0100, ?lvaro Fern?ndez Rojas wrote:
> Hi Alan,
>
> > El 23 feb 2021, a las 16:54, Alan Stern <[email protected]> escribi?:
> >
> > On Tue, Feb 23, 2021 at 04:50:04PM +0100, ?lvaro Fern?ndez Rojas wrote:
> >> Over-current reporting isn't supported on some platforms such as bcm63xx.
> >> These devices will incorrectly report over-current if this flag isn't properly
> >> activated.
> >>
> >> Signed-off-by: ?lvaro Fern?ndez Rojas <[email protected]>
> >> ---
> >> Documentation/devicetree/bindings/usb/generic-ehci.yaml | 5 +++++
> >> 1 file changed, 5 insertions(+)
> >>
> >> diff --git a/Documentation/devicetree/bindings/usb/generic-ehci.yaml b/Documentation/devicetree/bindings/usb/generic-ehci.yaml
> >> index cf83f2d9afac..294bbf02399e 100644
> >> --- a/Documentation/devicetree/bindings/usb/generic-ehci.yaml
> >> +++ b/Documentation/devicetree/bindings/usb/generic-ehci.yaml
> >> @@ -117,6 +117,11 @@ properties:
> >> Set this flag if EHCI has a Transaction Translator built into
> >> the root hub.
> >>
> >> + ignore-oc:
> >> + $ref: /schemas/types.yaml#/definitions/flag
> >> + description:
> >> + Set this flag for HCDs without over-current reporting support.
> >
> > This is not a good description of a device property. DT entries are
> > supposed to described the hardware, not talk about how to use it.
>
> Any suggestions on a proper description?
>
> >
> > When you say that the bcm63xx doesn't support over-current reporting,
> > what exactly do you mean? Do you mean that sometimes the hardware turns
> > on the over-current bit when an over-current isn't actually present? Or
> > do you mean something else?
>
> Yes, the hardware turns on the over-current bit with no over-current present.

Okay, in that case the property should be named something like
"spurious_oc", and the description should say something like:

Set this flag to indicate that the hardware sometimes turns on
the OC bit when an over-current isn't actually present.

Alan Stern