Add binding documentation for the TI LMP92064 dual channel SPI ADC.
Changes from v1 -> v2:
- Rename the "shunt-resistor" devicetree property to
"shunt-resistor-micro-ohms".
- Add supply regulator support for the two voltage domains of the chip
(vdd and vdig).
- Add reference to spi-peripheral-props.yaml
Signed-off-by: Leonard Göhrs <[email protected]>
---
.../bindings/iio/adc/ti,lmp92064.yaml | 70 +++++++++++++++++++
1 file changed, 70 insertions(+)
create mode 100644 Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml
diff --git a/Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml b/Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml
new file mode 100644
index 000000000000..357b15ebd897
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml
@@ -0,0 +1,70 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/ti,lmp92064.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments LMP92064 Precision Current and Voltage Sensor.
+
+maintainers:
+ - Leonard Göhrs <[email protected]>
+
+description: |
+ The LMP92064 is a two channel ADC intended for combined voltage and current
+ measurements.
+
+ The device contains two ADCs to allow simultaneous sampling of voltage and
+ current and thus of instantaneous power consumption.
+
+properties:
+ compatible:
+ enum:
+ - ti,lmp92064
+
+ reg:
+ maxItems: 1
+
+ vdd-supply:
+ description: Regulator that provides power to the main part of the chip
+
+ vdig-supply:
+ description: |
+ Regulator that provides power to the digital I/O part of the chip
+
+ shunt-resistor-micro-ohms:
+ description: |
+ Value of the shunt resistor (in µΩ) connected between INCP and INCN,
+ across which current is measured. Used to provide correct scaling of the
+ raw ADC measurement.
+
+ reset-gpios:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - shunt-resistor-micro-ohms
+
+allOf:
+ - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ spi {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ adc@0 {
+ compatible = "ti,lmp92064";
+ reg = <0>;
+ vdd-supply = <&vdd>;
+ vdig-supply = <&vdd>;
+ spi-max-frequency = <20000000>;
+ shunt-resistor-micro-ohms = <15000>;
+ reset-gpios = <&gpio1 16 GPIO_ACTIVE_HIGH>;
+ };
+ };
+...
--
2.30.2
On Tue, 01 Nov 2022 07:48:03 +0100, Leonard Göhrs wrote:
> Add binding documentation for the TI LMP92064 dual channel SPI ADC.
>
> Changes from v1 -> v2:
>
> - Rename the "shunt-resistor" devicetree property to
> "shunt-resistor-micro-ohms".
> - Add supply regulator support for the two voltage domains of the chip
> (vdd and vdig).
> - Add reference to spi-peripheral-props.yaml
>
> Signed-off-by: Leonard Göhrs <[email protected]>
> ---
> .../bindings/iio/adc/ti,lmp92064.yaml | 70 +++++++++++++++++++
> 1 file changed, 70 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml
>
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/adc/ti,lmp92064.example.dtb: adc@0: 'spi-max-frequency' does not match any of the regexes: 'pinctrl-[0-9]+'
From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/patch/
This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit.
On Tue, Nov 01, 2022 at 07:48:03AM +0100, Leonard Göhrs wrote:
> Add binding documentation for the TI LMP92064 dual channel SPI ADC.
>
> Changes from v1 -> v2:
>
> - Rename the "shunt-resistor" devicetree property to
> "shunt-resistor-micro-ohms".
> - Add supply regulator support for the two voltage domains of the chip
> (vdd and vdig).
> - Add reference to spi-peripheral-props.yaml
>
> Signed-off-by: Leonard Göhrs <[email protected]>
> ---
> .../bindings/iio/adc/ti,lmp92064.yaml | 70 +++++++++++++++++++
> 1 file changed, 70 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml b/Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml
> new file mode 100644
> index 000000000000..357b15ebd897
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml
> @@ -0,0 +1,70 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/ti,lmp92064.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments LMP92064 Precision Current and Voltage Sensor.
> +
> +maintainers:
> + - Leonard Göhrs <[email protected]>
> +
> +description: |
> + The LMP92064 is a two channel ADC intended for combined voltage and current
> + measurements.
> +
> + The device contains two ADCs to allow simultaneous sampling of voltage and
> + current and thus of instantaneous power consumption.
> +
> +properties:
> + compatible:
> + enum:
> + - ti,lmp92064
> +
> + reg:
> + maxItems: 1
> +
> + vdd-supply:
> + description: Regulator that provides power to the main part of the chip
> +
> + vdig-supply:
> + description: |
> + Regulator that provides power to the digital I/O part of the chip
> +
> + shunt-resistor-micro-ohms:
> + description: |
> + Value of the shunt resistor (in µΩ) connected between INCP and INCN,
> + across which current is measured. Used to provide correct scaling of the
> + raw ADC measurement.
> +
> + reset-gpios:
> + maxItems: 1
> +
> +required:
> + - compatible
> + - reg
> + - shunt-resistor-micro-ohms
> +
> +allOf:
> + - $ref: /schemas/spi/spi-peripheral-props.yaml#
> +
> +additionalProperties: false
This should be unevaluatedProperties instead.
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + spi {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + adc@0 {
> + compatible = "ti,lmp92064";
> + reg = <0>;
> + vdd-supply = <&vdd>;
> + vdig-supply = <&vdd>;
> + spi-max-frequency = <20000000>;
> + shunt-resistor-micro-ohms = <15000>;
> + reset-gpios = <&gpio1 16 GPIO_ACTIVE_HIGH>;
> + };
> + };
> +...
> --
> 2.30.2
>
>
On Tue, 1 Nov 2022 07:28:24 -0500
Rob Herring <[email protected]> wrote:
> On Tue, Nov 01, 2022 at 07:48:03AM +0100, Leonard Göhrs wrote:
> > Add binding documentation for the TI LMP92064 dual channel SPI ADC.
> >
> > Changes from v1 -> v2:
> >
> > - Rename the "shunt-resistor" devicetree property to
> > "shunt-resistor-micro-ohms".
> > - Add supply regulator support for the two voltage domains of the chip
> > (vdd and vdig).
> > - Add reference to spi-peripheral-props.yaml
Change log should be below the ---
We don't want to directly capture in the git tree - though I will apply
a link tag so people can find the thread on lore.kernel.org if they want
this information.
I'm aware that for some parts of the kernel the policy is different but in IIO
we assume the link tag is sufficient.
> >
> > Signed-off-by: Leonard Göhrs <[email protected]>
> > ---
> > .../bindings/iio/adc/ti,lmp92064.yaml | 70 +++++++++++++++++++
> > 1 file changed, 70 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/iio/adc/ti,lmp92064.yaml
> >