Re: [PATCH 3/3] dt-bindings: iio: Add ltc2947 documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Rob,

Just wanted to clarify something which I don't know if is something I'm
doing wrong or if it is some issue.

On Wed, 2019-10-02 at 14:06 -0500, Rob Herring wrote:
> 
> On Wed, Oct 2, 2019 at 10:09 AM Sa, Nuno <Nuno.Sa@xxxxxxxxxx> wrote:
> > On Wed, 2019-10-02 at 09:19 -0500, Rob Herring wrote:
> > > On Tue, Sep 24, 2019 at 02:49:45PM +0200, Nuno Sá wrote:
> > > > Document the LTC2947 device devicetree bindings.
> > > > 
> > > > Signed-off-by: Nuno Sá <nuno.sa@xxxxxxxxxx>
> > > > ---
> > > >  .../bindings/hwmon/adi,ltc2947.yaml           | 101
> > > > ++++++++++++++++++
> > > >  MAINTAINERS                                   |   1 +
> > > >  2 files changed, 102 insertions(+)
> > > >  create mode 100644
> > > > Documentation/devicetree/bindings/hwmon/adi,ltc2947.yaml
> > > > 
> > > > diff --git
> > > > a/Documentation/devicetree/bindings/hwmon/adi,ltc2947.yaml
> > > > b/Documentation/devicetree/bindings/hwmon/adi,ltc2947.yaml
> > > > new file mode 100644
> > > > index 000000000000..2ea0187421d4
> > > > --- /dev/null
> > > > +++ b/Documentation/devicetree/bindings/hwmon/adi,ltc2947.yaml
> > > > @@ -0,0 +1,101 @@
> > > 
> > > Missing license. Please make new bindings (GPL-2.0-only OR BSD-2-
> > > Clause)
> > 
> > ack.
> > 
> > > > +%YAML 1.2
> > > > +---
> > > > +$id:
> > > > http://devicetree.org/schemas/bindings/hwmon/adi,ltc2947.yaml#
> > > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > > +
> > > > +title: Analog Devices LTC2947 high precision power and energy
> > > > monitor
> > > > +
> > > > +maintainers:
> > > > +  - Nuno Sá <nuno.sa@xxxxxxxxxx>
> > > > +
> > > > +description: |
> > > > +  Analog Devices LTC2947 high precision power and energy
> > > > monitor
> > > > over SPI or I2C.
> > > > +
> > > > +
> > > > https://www.analog.com/media/en/technical-documentation/data-sheets/LTC2947.pdf
> > > > +
> > > > +properties:
> > > > +  compatible:
> > > > +    enum:
> > > > +      - adi,ltc2947
> > > > +
> > > > +  reg:
> > > > +    maxItems: 1
> > > > +
> > > > +  clocks:
> > > > +    description:
> > > > +      The LTC2947 uses either a trimmed internal oscillator or
> > > > an
> > > > external clock
> > > > +      as the time base for determining the integration period
> > > > to
> > > > represent time,
> > > > +      charge and energy. When an external clock is used, this
> > > > property must be
> > > > +      set accordingly.
> > > > +    maxItems: 1
> > > > +
> > > > +  adi,accumulator-ctl-pol:
> > > > +    description:
> > > > +      This property controls the polarity of current that is
> > > > accumulated to
> > > > +      calculate charge and energy so that, they can be only
> > > > accumulated for
> > > > +      positive current for example. Since there are two sets
> > > > of
> > > > registers for
> > > > +      the accumulated values, this entry can also have two
> > > > items
> > > > which sets
> > > > +      energy1/charge1 and energy2/charger2 respectively. Check
> > > > table 12 of the
> > > > +      datasheet for more information on the supported options.
> > > > +    allOf:
> > > > +      - $ref: /schemas/types.yaml#/definitions/uint32-array
> > > > +      - enum: [0, 1, 2, 3]
> > > > +      - minItems: 2
> > > > +      - maxItems: 2
> > > > +    default: [0, 0]
> > > 
> > > This should be:
> > > 
> > > allOf:
> > >   - $ref: ...
> > > items:
> > >   enum: [0, 1, 2, 3]
> > >   default: 0
> > > minItems: 2
> > > maxItems: 2

When trying the above I get:

"ltc2947@0: adi,accumulator-ctl-pol:0: [0, 1] is not valid under any of
the given schemas"

> > I was expecting this already. When upstreaming another device, I
> > realized some errors with `make dt_binding_check` when evaluating
> > the
> > example. Just for my understanding, is this also incorrect?
> 
> The allOf structure like this also works. You'll get better error
> messages if schemas are not under an allOf.
> 
> > allOf:
> >   - $ref: /schemas/types.yaml#/definitions/uint32-array
> >   - minItems: 2
> >     maxItems: 2
> >     items:
> >       enum: [0, 1, 2, 3]
> >     default: 0
> 
> However, 'default' needs to be indented under 'items'.

In this form, I don't get any warning/error when checking the dts
example.

> > I used a similar pattern in another device that is also waiting for
> > review :).
> > > > +
> > > > +  adi,accumulation-deadband-microamp:
> > > > +    description:
> > > > +      This property controls the Accumulation Dead band which
> > > > allows to set the
> > > > +      level of current below which no accumulation takes
> > > > place.
> > > > +    allOf:
> > > > +      - $ref: /schemas/types.yaml#/definitions/uint32
> > > > +      - maximum: 255
> > > 
> > > maximum should be at same indent as allOf. Or default should be
> > > at
> > > the
> > > same level as maximum (under a single '-' list entry).
> > 
> > So it should be?
> > 
> > allOf:
> >   - $ref: /schemas/types.yaml#/definitions/uint32
> >   - maximum: 255
> >     default: 0
> 
> Yes.

Regards,
Nuno Sá




[Index of Archives]     [LM Sensors]     [Linux Sound]     [ALSA Users]     [ALSA Devel]     [Linux Audio Users]     [Linux Media]     [Kernel]     [Gimp]     [Yosemite News]     [Linux Media]

  Powered by Linux