Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Tue, 23 Feb 2021 11:09:32 -0500
From:   Alan Stern <stern@rowland.harvard.edu>
To:     =?iso-8859-1?Q?=C1lvaro_Fern=E1ndez?= Rojas <noltari@gmail.com>
Cc:     Florian Fainelli <f.fainelli@gmail.com>,
        Jonas Gorski <jonas.gorski@gmail.com>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Rob Herring <robh+dt@kernel.org>, devicetree@vger.kernel.org,
        linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH 1/2] dt-bindings: usb: generic-ehci: document ignore-oc
 flag
Message-ID: <20210223160932.GD1261797@rowland.harvard.edu>
References: <20210223155005.21712-1-noltari@gmail.com>
 <20210223155005.21712-2-noltari@gmail.com>
 <20210223155443.GB1261797@rowland.harvard.edu>
 <54E1894F-C8D8-4E2F-92DF-DC891153BAAB@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <54E1894F-C8D8-4E2F-92DF-DC891153BAAB@gmail.com>
User-Agent: Mutt/1.10.1 (2018-07-13)
Precedence: bulk

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 <stern@rowland.harvard.edu> 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 <noltari@gmail.com>
> >> ---
> >> 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