Commit ce66e52b authored by Jonathan Cameron's avatar Jonathan Cameron
Browse files

dt-bindings:iio:afe:current-sense-shunt: txt to yaml conversion. 



Very simple binding. As such straight forward conversion.

Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Cc: Peter Rosin <peda@axentia.se>
Link: https://lore.kernel.org/r/20201031181242.742301-7-jic23@kernel.org
parent fbac26b9

Documentation/devicetree/bindings/iio/afe/current-sense-shunt.txt

deleted100644 → 0
+0 −41
Original line number Diff line number Diff line 
Current Sense Shunt

===================



When an io-channel measures the voltage over a current sense shunt,

the interesting measurement is almost always the current through the

shunt, not the voltage over it. This binding describes such a current

sense circuit.



Required properties:

- compatible : "current-sense-shunt"

- io-channels : Channel node of a voltage io-channel.

- shunt-resistor-micro-ohms : The shunt resistance in microohms.



Example:

The system current is measured by measuring the voltage over a

3.3 ohms shunt resistor.



sysi {

	compatible = "current-sense-shunt";

	io-channels = <&tiadc 0>;



	/* Divide the voltage by 3300000/1000000 (or 3.3) for the current. */

	shunt-resistor-micro-ohms = <3300000>;

};



&i2c {

	tiadc: adc@48 {

		compatible = "ti,ads1015";

		reg = <0x48>;

		#io-channel-cells = <1>;



		#address-cells = <1>;

		#size-cells = <0>;



		channel@0 { /* IN0,IN1 differential */

			reg = <0>;

			ti,gain = <1>;

			ti,datarate = <4>;

		};

	};

};

Documentation/devicetree/bindings/iio/afe/current-sense-shunt.yaml

0 → 100644
+64 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/iio/afe/current-sense-shunt.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Current Sense Shunt



maintainers:

  - Peter Rosin <peda@axentia.se>



description: |

  When an io-channel measures the voltage over a current sense shunt,

  the interesting measurement is almost always the current through the

  shunt, not the voltage over it. This binding describes such a current

  sense circuit.



properties:

  compatible:

    const: current-sense-shunt



  io-channels:

    maxItems: 1

    description: |

      Channel node of a voltage io-channel.



  shunt-resistor-micro-ohms:

    description: The shunt resistance.



required:

  - compatible

  - io-channels

  - shunt-resistor-micro-ohms



additionalProperties: false



examples:

  - |

    i2c {

        #address-cells = <1>;

        #size-cells = <0>;

        tiadc: adc@48 {

            compatible = "ti,ads1015";

            reg = <0x48>;

            #io-channel-cells = <1>;



            #address-cells = <1>;

            #size-cells = <0>;



            channel@0 { /* IN0,IN1 differential */

                reg = <0>;

                ti,gain = <1>;

                ti,datarate = <4>;

            };

        };

    };

    sysi {

        compatible = "current-sense-shunt";

        io-channels = <&tiadc 0>;



        /* Divide the voltage by 3300000/1000000 (or 3.3) for the current. */

        shunt-resistor-micro-ohms = <3300000>;

    };

...