Re: [v2,1/2] hwmon: (adcxx) add devictree bindings documentation

From: Guenter Roeck
Date: Fri Sep 01 2017 - 10:33:05 EST


On Mon, Aug 21, 2017 at 10:19:51AM +0200, Florian Eckert wrote:
> Document the devicetree bindings for the adcxx.
>
> Signed-off-by: Florian Eckert <fe@xxxxxxxxxx>
> ---
> v2:
> - use regulator voltage binding
>
> 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
> +
> +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
> +- 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).

s/exists/exist/

> +
> +Example:
> +
> +adc@6 {
> + compatible = "national,adcxx2s";
> + reg = <6 0>;
> + spi-max-frequency = <1000000>;

I asssume that means that standard spi properties are accepted / required,
which I think should be documented. We'll need input from Rob for that.

Thanks,
Guenter

> + vref-supply = <&vref>;
> +};