From: Jonathan Cameron <Jonathan.Cameron@Huawei.com>
To: Paul Cercueil <paul@crapouillou.net>
Cc: citral23 <cbranchereau@gmail.com>, <jic23@kernel.org>,
<lars@metafoo.de>, <linux-mips@vger.kernel.org>,
<linux-iio@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<robh+dt@kernel.org>, <devicetree@vger.kernel.org>,
<linux@roeck-us.net>, <contact@artur-rojek.eu>
Subject: Re: [PATCH 6/6] dt-bindings: iio/adc: ingenic: add the JZ4760(B) socs to the sadc Documentation
Date: Fri, 23 Jul 2021 17:10:15 +0100 [thread overview]
Message-ID: <20210723171015.00001b44@Huawei.com> (raw)
In-Reply-To: <L90MWQ.K24XQ4Q0L9XN@crapouillou.net>
On Wed, 21 Jul 2021 20:17:45 +0100
Paul Cercueil <paul@crapouillou.net> wrote:
> Hi Christophe,
>
> Please always add a short description in your patches, even if all you
> do is repeat the patch title.
>
>
> Le mer., juil. 21 2021 at 12:53:17 +0200, citral23
> <cbranchereau@gmail.com> a écrit :
> > Signed-off-by: citral23 <cbranchereau@gmail.com>
> > ---
> > .../devicetree/bindings/iio/adc/ingenic,adc.yaml | 9
> > +++++++++
> > 1 file changed, 9 insertions(+)
> >
> > diff --git
> > a/Documentation/devicetree/bindings/iio/adc/ingenic,adc.yaml
> > b/Documentation/devicetree/bindings/iio/adc/ingenic,adc.yaml
> > index 433a3fb55a2e..1b423adba61d 100644
> > --- a/Documentation/devicetree/bindings/iio/adc/ingenic,adc.yaml
> > +++ b/Documentation/devicetree/bindings/iio/adc/ingenic,adc.yaml
> > @@ -23,6 +23,8 @@ properties:
> > enum:
> > - ingenic,jz4725b-adc
> > - ingenic,jz4740-adc
> > + - ingenic,jz4760-adc
> > + - ingenic,jz4760b-adc
> > - ingenic,jz4770-adc
> >
> > '#io-channel-cells':
> > @@ -43,6 +45,12 @@ properties:
> > interrupts:
> > maxItems: 1
> >
> > + ingenic,use-internal-divider:
> > + description:
> > + This property can be used to set VBAT_SEL in the JZ4760B CFG
> > register
> > + to sample the battery voltage from the internal divider. If
> > absent, it
> > + will sample the external divider.
>
> Please remove trailing spaces. And you don't need to describe internal
> behaviour; you only need to explain the functionality in a user-facing
> perspective. Something like:
>
> "If present, battery voltage is read from the VBAT_IR pin, which has an
> internal /4 divider. If absent, it is read through the VBAT_ER pin,
> which does not have such divider."
>
> You also don't specify the type of the property, please add "type:
> boolean" before the description.
>
> There should also be a way to make sure that this property can only be
> used with the JZ4760B SoC. So a dependency for this vendor property on
> the "ingenic,jz4760b-adc" compatible string. But I'm honestly not sure
> how to express that... Maybe Rob can help.
Lots of examples in tree.
e.g.
https://elixir.bootlin.com/linux/v5.14-rc2/source/Documentation/devicetree/bindings/iio/st,st-sensors.yaml#L153
Basically you have an if block matching the compatible and for non matches
set it to false. That combined with additionaProperties: false enforces
the property can't exist for those other devices.
>
> > +
> > required:
> > - compatible
> > - '#io-channel-cells'
> > @@ -53,6 +61,7 @@ required:
> >
> > additionalProperties: false
> >
> > +
>
> Remove the extra newline.
>
> Cheers,
> -Paul
>
> > examples:
> > - |
> > #include <dt-bindings/clock/jz4740-cgu.h>
> > --
> > 2.30.2
> >
>
>
next prev parent reply other threads:[~2021-07-23 16:10 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-21 10:53 [PATCH] Ingenic: iio/adc: add JZ4760(B) support to the citral23
2021-07-21 10:53 ` [PATCH 1/6] iio/adc: ingenic: rename has_aux2 to has_aux_md citral23
2021-07-21 17:46 ` Paul Cercueil
2021-07-21 10:53 ` [PATCH 2/6] dt-bindings: iio/adc: add an INGENIC_ADC_AUX0 entry citral23
2021-07-21 17:46 ` Paul Cercueil
2021-07-21 10:53 ` [PATCH 3/6] iio/adc: ingenic: add JZ4760 support to the sadc driver citral23
2021-07-21 18:15 ` Paul Cercueil
2021-07-22 5:09 ` Christophe Branchereau
2021-07-22 5:23 ` Guenter Roeck
2021-07-23 8:58 ` [PATCH V2 0/5] iio/adc: ingenic: add support for the JZ4760(B) Socs to the ingenic " Christophe Branchereau
2021-07-23 8:58 ` [PATCH V2 1/5] iio/adc: ingenic: rename has_aux2 to has_aux_md Christophe Branchereau
2021-07-23 8:58 ` [PATCH V2 2/5] dt-bindings: iio/adc: add an INGENIC_ADC_AUX0 entry Christophe Branchereau
2021-07-23 8:58 ` [PATCH V2 3/5] iio/adc: ingenic: add JZ4760 support to the sadc driver Christophe Branchereau
2021-07-23 8:58 ` [PATCH V2 4/5] iio/adc: ingenic: add JZ4760B " Christophe Branchereau
2021-07-23 16:15 ` Jonathan Cameron
2021-07-23 8:58 ` [PATCH V2 5/5] dt-bindings: iio/adc: ingenic: add the JZ4760(B) socs to the sadc Documentation Christophe Branchereau
2021-07-23 16:16 ` Jonathan Cameron
2021-07-24 7:33 ` Christophe Branchereau
2021-07-24 15:23 ` Jonathan Cameron
2021-07-23 16:03 ` [PATCH V2 0/5] iio/adc: ingenic: add support for the JZ4760(B) Socs to the ingenic sadc driver Jonathan Cameron
2021-07-23 16:13 ` [PATCH 3/6] iio/adc: ingenic: add JZ4760 support to the " Jonathan Cameron
2021-07-21 10:53 ` [PATCH 4/6] iio/adc: ingenic: add JZ4760B " citral23
2021-07-21 18:24 ` Paul Cercueil
2021-07-21 10:53 ` [PATCH 5/6] iio/adc: ingenic: modify citral23
2021-07-21 18:28 ` Paul Cercueil
2021-07-21 10:53 ` [PATCH 6/6] dt-bindings: iio/adc: ingenic: add the JZ4760(B) socs to the sadc Documentation citral23
2021-07-21 19:17 ` Paul Cercueil
2021-07-23 16:10 ` Jonathan Cameron [this message]
2021-07-22 2:09 ` Rob Herring
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210723171015.00001b44@Huawei.com \
--to=jonathan.cameron@huawei.com \
--cc=cbranchereau@gmail.com \
--cc=contact@artur-rojek.eu \
--cc=devicetree@vger.kernel.org \
--cc=jic23@kernel.org \
--cc=lars@metafoo.de \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mips@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=paul@crapouillou.net \
--cc=robh+dt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).