diff mbox series

[05/10] dt-bindings:iio:afe:current-sense-amplifier: txt to yaml conversion.

Message ID 20201031181242.742301-6-jic23@kernel.org (mailing list archive)
State New
Headers show
Series dt-bindings: iio: conversion of consumer drivers | expand

Commit Message

Jonathan Cameron Oct. 31, 2020, 6:12 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Note this includes a fix in the example where we had *-mul instead of
*-mult.  The binding doc and driver agree that it should be *-mult

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Peter Rosin <peda@axentia.se>
---
 .../iio/afe/current-sense-amplifier.txt       | 26 ---------
 .../iio/afe/current-sense-amplifier.yaml      | 55 +++++++++++++++++++
 2 files changed, 55 insertions(+), 26 deletions(-)

Comments

Rob Herring Nov. 3, 2020, 3:55 p.m. UTC | #1
On Sat, Oct 31, 2020 at 06:12:37PM +0000, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> Note this includes a fix in the example where we had *-mul instead of
> *-mult.  The binding doc and driver agree that it should be *-mult
> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Peter Rosin <peda@axentia.se>
> ---
>  .../iio/afe/current-sense-amplifier.txt       | 26 ---------
>  .../iio/afe/current-sense-amplifier.yaml      | 55 +++++++++++++++++++
>  2 files changed, 55 insertions(+), 26 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.txt b/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.txt
> deleted file mode 100644
> index 821b61b8c542..000000000000
> --- a/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.txt
> +++ /dev/null
> @@ -1,26 +0,0 @@
> -Current Sense Amplifier
> -=======================
> -
> -When an io-channel measures the output voltage from a current sense
> -amplifier, the interesting measurement is almost always the current
> -through the sense resistor, not the voltage output. This binding
> -describes such a current sense circuit.
> -
> -Required properties:
> -- compatible : "current-sense-amplifier"
> -- io-channels : Channel node of a voltage io-channel.
> -- sense-resistor-micro-ohms : The sense resistance in microohms.
> -
> -Optional properties:
> -- sense-gain-mult: Amplifier gain multiplier. The default is <1>.
> -- sense-gain-div: Amplifier gain divider. The default is <1>.
> -
> -Example:
> -
> -sysi {
> -	compatible = "current-sense-amplifier";
> -	io-channels = <&tiadc 0>;
> -
> -	sense-resistor-micro-ohms = <20000>;
> -	sense-gain-mul = <50>;
> -};
> diff --git a/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.yaml b/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.yaml
> new file mode 100644
> index 000000000000..920bdd8d12d6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.yaml
> @@ -0,0 +1,55 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/afe/current-sense-amplifier.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Current Sense Amplifier
> +
> +maintainers:
> +  - Peter Rosin <peda@axentia.se>
> +
> +description: |
> +  When an io-channel measures the output voltage from a current sense
> +  amplifier, the interesting measurement is almost always the current
> +  through the sense resistor, not the voltage output. This binding
> +  describes such a current sense circuit.
> +
> +properties:
> +  compatible:
> +    const: current-sense-amplifier
> +
> +  io-channels:
> +    maxItems: 1
> +    description: |
> +      Channel node of a voltage io-channel.
> +
> +  sense-resistor-micro-ohms:
> +    $ref: /schemas/types.yaml#/definitions/uint32

Don't need a type for props with unit suffix.

> +    description: The sense resistance.
> +
> +  sense-gain-mult:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: Amplifier gain multiplier. The default is <1>.
> +
> +  sense-gain-div:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: Amplifier gain divider. The default is <1>.
> +
> +required:
> +  - compatible
> +  - io-channels
> +  - sense-resistor-micro-ohms
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    sysi {
> +        compatible = "current-sense-amplifier";
> +        io-channels = <&tiadc 0>;
> +
> +        sense-resistor-micro-ohms = <20000>;
> +        sense-gain-mult = <50>;
> +    };
> +...
> -- 
> 2.28.0
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.txt b/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.txt
deleted file mode 100644
index 821b61b8c542..000000000000
--- a/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.txt
+++ /dev/null
@@ -1,26 +0,0 @@ 
-Current Sense Amplifier
-=======================
-
-When an io-channel measures the output voltage from a current sense
-amplifier, the interesting measurement is almost always the current
-through the sense resistor, not the voltage output. This binding
-describes such a current sense circuit.
-
-Required properties:
-- compatible : "current-sense-amplifier"
-- io-channels : Channel node of a voltage io-channel.
-- sense-resistor-micro-ohms : The sense resistance in microohms.
-
-Optional properties:
-- sense-gain-mult: Amplifier gain multiplier. The default is <1>.
-- sense-gain-div: Amplifier gain divider. The default is <1>.
-
-Example:
-
-sysi {
-	compatible = "current-sense-amplifier";
-	io-channels = <&tiadc 0>;
-
-	sense-resistor-micro-ohms = <20000>;
-	sense-gain-mul = <50>;
-};
diff --git a/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.yaml b/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.yaml
new file mode 100644
index 000000000000..920bdd8d12d6
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.yaml
@@ -0,0 +1,55 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/afe/current-sense-amplifier.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Current Sense Amplifier
+
+maintainers:
+  - Peter Rosin <peda@axentia.se>
+
+description: |
+  When an io-channel measures the output voltage from a current sense
+  amplifier, the interesting measurement is almost always the current
+  through the sense resistor, not the voltage output. This binding
+  describes such a current sense circuit.
+
+properties:
+  compatible:
+    const: current-sense-amplifier
+
+  io-channels:
+    maxItems: 1
+    description: |
+      Channel node of a voltage io-channel.
+
+  sense-resistor-micro-ohms:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: The sense resistance.
+
+  sense-gain-mult:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: Amplifier gain multiplier. The default is <1>.
+
+  sense-gain-div:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: Amplifier gain divider. The default is <1>.
+
+required:
+  - compatible
+  - io-channels
+  - sense-resistor-micro-ohms
+
+additionalProperties: false
+
+examples:
+  - |
+    sysi {
+        compatible = "current-sense-amplifier";
+        io-channels = <&tiadc 0>;
+
+        sense-resistor-micro-ohms = <20000>;
+        sense-gain-mult = <50>;
+    };
+...