[v3,1/2] hwmon: (adcxx) add devictree bindings documentation
diff mbox series

Message ID 20181115135013.30723-2-fe@dev.tdt.de
State New
Headers show
Series
  • hwmon: Add device tree support for adcxx
Related show

Commit Message

Florian Eckert Nov. 15, 2018, 1:50 p.m. UTC
Document the devicetree bindings for the adcxx.

Signed-off-by: Florian Eckert <fe@dev.tdt.de>
---
 Documentation/devicetree/bindings/hwmon/adcxx.txt | 24 +++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/adcxx.txt

Comments

Rob Herring Nov. 17, 2018, 2:40 p.m. UTC | #1
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@dev.tdt.de>
> ---
>  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
>
Guenter Roeck Nov. 19, 2018, 1:25 a.m. UTC | #2
On Sat, Nov 17, 2018 at 08:40:41AM -0600, Rob Herring wrote:
> 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@dev.tdt.de>
> > ---
> >  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/
> 
FWIW, the hwmon driver for this chip series would be a perfect candidate
for a conversion to an iio driver. The driver predates the existence of
iio.

Florian, any interest doing that ? It is quite likely that the chip isn't
used for hardware monitoring.

> > +
> > +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.
> 
Should we list all of them ?

ADC121S021 ADC121S051 ADC121S101
ADC101S021 ADC101S051 ADC101S101
ADC081S021 ADC081S051 ADC081S101

ADC121S625 ADC121S655 ADC121S705

ADC122S021 ADC122S051 ADC122S101
ADC102S021 ADC102S051 ADC102S101
ADC082S021 ADC082S051 ADC082S101

ADC122S625 ADC122S655 ADC122S706

ADC124S021 ADC124S051 ADC124S101
ADC104S021 ADC104S051 ADC104S101
ADC084S021 ADC084S051 ADC084S101

ADC128S022 ADC128S052 ADC128S102

I hope I didn't miss any.

Guenter

> > +- 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
> >
Florian Eckert Nov. 20, 2018, 7:16 a.m. UTC | #3
Hello Guenter,

>> 
>> Needs a better description of what this h/w is.
>> 
>> ADCs go in iio/adc/
>> 
> FWIW, the hwmon driver for this chip series would be a perfect 
> candidate
> for a conversion to an iio driver. The driver predates the existence of
> iio.
> 
> Florian, any interest doing that ? It is quite likely that the chip 
> isn't
> used for hardware monitoring.

I will have a look on the next week about your suggestion to port this 
device
to iio/adc.

   - Florian

Patch
diff mbox series

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).
+
+Example:
+
+adc@6 {
+	compatible = "national,adcxx2s";
+	reg = <6 0>;
+	spi-max-frequency = <1000000>;
+	vref-supply = <&vref>;
+};