Re: [PATCH v3 1/2] hwmon: (adcxx) add devictree bindings documentation

From: Rob Herring
Date: Sat Nov 17 2018 - 09:40:53 EST


On Thu, Nov 15, 2018 at 02:50:12PM +0100, Florian Eckert wrote:
> Document the devicetree bindings for the adcxx.
>
> Signed-off-by: Florian Eckert <fe@xxxxxxxxxx>
> ---
> Documentation/devicetree/bindings/hwmon/adcxx.txt | 24 +++++++++++++++++++++++
> 1 file changed, 24 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/hwmon/adcxx.txt
>
> diff --git a/Documentation/devicetree/bindings/hwmon/adcxx.txt b/Documentation/devicetree/bindings/hwmon/adcxx.txt
> new file mode 100644
> index 000000000000..a94a5fe21b6d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/adcxx.txt
> @@ -0,0 +1,24 @@
> +adcxx properties

Needs a better description of what this h/w is.

ADCs go in iio/adc/

> +
> +Required properties:
> +- compatible: Must be one of the following:
> + - "national,adcxx1s" for adcxx1s
> + - "national,adcxx2s" for adcxx2s
> + - "national,adcxx4s" for adcxx4s
> + - "national,adcxx8s" for adcxx8s

Don't use wildcards in compatible strings.

> +- reg: SPI address for chip
> +
> +Optional properties:
> +
> +- vref-supply
> + The external reference in microvolt for this device is set to this value.
> + If it does not exists the reference will be set to 3300000uV (3.3V).
> +
> +Example:
> +
> +adc@6 {
> + compatible = "national,adcxx2s";
> + reg = <6 0>;

? SPI addresses are a single cell.

> + spi-max-frequency = <1000000>;
> + vref-supply = <&vref>;
> +};
> --
> 2.11.0
>