Re: [PATCH] dt-bindings: hwmon: max20730: adding device tree doc for max20730

From: Rob Herring
Date: Tue Sep 22 2020 - 18:25:08 EST


On Tue, Sep 15, 2020 at 08:04:24PM -0700, Guenter Roeck wrote:
> On 9/10/20 10:06 AM, Chu Lin wrote:
> > Testing:
> > make dt_binding_check
> >
>
> This isn't really an appropriate patch description.

And will always pass with a .txt file...

>
> > Signed-off-by: Chu Lin <linchuyuan@xxxxxxxxxx>
> > ---
> > .../devicetree/bindings/hwmon/max20730.txt | 23 +++++++++++++++++++
>
> AFAIK this needs to be written as .yaml file.

Yes.

>
> Guenter
>
> > MAINTAINERS | 1 +
> > 2 files changed, 24 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/hwmon/max20730.txt
> >
> > diff --git a/Documentation/devicetree/bindings/hwmon/max20730.txt b/Documentation/devicetree/bindings/hwmon/max20730.txt
> > new file mode 100644
> > index 000000000000..3afb42b04567
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/hwmon/max20730.txt
> > @@ -0,0 +1,23 @@
> > +max20730 properties
> > +
> > +Required properties:
> > +- compatible: Must be one of the supported compatible strings:
> > + "maxim,max20730" for max20730
> > + "maxim,max20734" for max20734
> > + "maxim,max20743" for max20743
> > +- reg: I2C address
> > +
> > +Optional properties:
> > +
> > +- vout-voltage-divider
> > + Resistance of the vout voltage divider.
> > + Two numbers, the first number is the output resistor,
> > + the second number is the total resistance.

Is this a common property for this type of device? And what type of
device is it because there's no description telling me?

> > +
> > +Example:
> > +
> > +max20730@10 {
> > + compatible = "maxim,max20730";
> > + reg = <0x10>;
> > + vout-voltage-divider = <1000 2000>;
> > +};
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 0a6ac3f00ed5..a04bf34a65b8 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -12371,6 +12371,7 @@ W: http://www.roeck-us.net/linux/drivers/
> > T: git git://git.kernel.org/pub/scm/linux/kernel/git/groeck/linux-staging.git
> > S: Maintained
> > F: Documentation/devicetree/bindings/hwmon/ibm,cffps1.txt
> > +F: Documentation/devicetree/bindings/hwmon/max20730.txt
> > F: Documentation/devicetree/bindings/hwmon/max31785.txt
> > F: Documentation/devicetree/bindings/hwmon/ltc2978.txt
> > F: Documentation/hwmon/adm1275
> >
>