diff mbox series

[2/3] dt-bindings: iio: adc: maxim,max1118 yaml conversion

Message ID 20200722171224.989138-3-jic23@kernel.org
State New
Headers show
Series dt-bindings: iio: adc: Maxim ADC yaml conversions | expand

Commit Message

Jonathan Cameron July 22, 2020, 5:12 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Simple device with a simple conversion.  Special handling needed
for the max1118 which is the only supported part that has an external
reference voltage.

Cc: Akinobu Mita <akinobu.mita@gmail.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
---
 .../devicetree/bindings/iio/adc/max1118.txt   | 21 -------
 .../bindings/iio/adc/maxim,max1118.yaml       | 59 +++++++++++++++++++
 2 files changed, 59 insertions(+), 21 deletions(-)

Comments

Rob Herring July 23, 2020, 9:21 p.m. UTC | #1
On Wed, Jul 22, 2020 at 06:12:23PM +0100, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> Simple device with a simple conversion.  Special handling needed
> for the max1118 which is the only supported part that has an external
> reference voltage.
> 
> Cc: Akinobu Mita <akinobu.mita@gmail.com>
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> ---
>  .../devicetree/bindings/iio/adc/max1118.txt   | 21 -------
>  .../bindings/iio/adc/maxim,max1118.yaml       | 59 +++++++++++++++++++
>  2 files changed, 59 insertions(+), 21 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/max1118.txt b/Documentation/devicetree/bindings/iio/adc/max1118.txt
> deleted file mode 100644
> index cf33d0b15a6d..000000000000
> --- a/Documentation/devicetree/bindings/iio/adc/max1118.txt
> +++ /dev/null
> @@ -1,21 +0,0 @@
> -* MAX1117/MAX1118/MAX1119 8-bit, dual-channel ADCs
> -
> -Required properties:
> - - compatible: Should be one of
> -	* "maxim,max1117"
> -	* "maxim,max1118"
> -	* "maxim,max1119"
> - - reg: spi chip select number for the device
> - - (max1118 only) vref-supply: The regulator supply for ADC reference voltage
> -
> -Recommended properties:
> - - spi-max-frequency: Definition as per
> -		Documentation/devicetree/bindings/spi/spi-bus.txt
> -
> -Example:
> -adc@0 {
> -	compatible = "maxim,max1118";
> -	reg = <0>;
> -	vref-supply = <&vdd_supply>;
> -	spi-max-frequency = <1000000>;
> -};
> diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max1118.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max1118.yaml
> new file mode 100644
> index 000000000000..ca24b8b23cde
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max1118.yaml
> @@ -0,0 +1,59 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/maxim,max1118.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Maxim MAX1118 and similar ADCs
> +
> +maintainers:
> +  - Akinobu Mita <akinobu.mita@gmail.com>
> +
> +description: |
> +    Dual channel 8bit ADCs.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - maxim,max1117
> +      - maxim,max1118
> +      - maxim,max1119
> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-max-frequency:
> +    maximum: 5000000
> +
> +required:
> +  - compatible
> +  - reg
> +
> +allOf:
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +           const: maxim,max1118
> +    then:
> +      properties:
> +        vref-supply:
> +          description: External reference, needed to establish input scaling

This needs to be moved to the main section when you add 
'additionalProperties'.

Then add an 'else' clause here with:

not:
  required:
    - vref-supply

Or this works too:

properties:
  vref-supply: false

> +
> +      required:
> +        - vref-supply
> +
> +examples:
> +  - |
> +    spi {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        adc@0 {
> +            compatible = "maxim,max1118";
> +            reg = <0>;
> +            vref-supply = <&adc_vref>;
> +            spi-max-frequency = <1000000>;
> +        };
> +    };
> +...
> -- 
> 2.27.0
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/max1118.txt b/Documentation/devicetree/bindings/iio/adc/max1118.txt
deleted file mode 100644
index cf33d0b15a6d..000000000000
--- a/Documentation/devicetree/bindings/iio/adc/max1118.txt
+++ /dev/null
@@ -1,21 +0,0 @@ 
-* MAX1117/MAX1118/MAX1119 8-bit, dual-channel ADCs
-
-Required properties:
- - compatible: Should be one of
-	* "maxim,max1117"
-	* "maxim,max1118"
-	* "maxim,max1119"
- - reg: spi chip select number for the device
- - (max1118 only) vref-supply: The regulator supply for ADC reference voltage
-
-Recommended properties:
- - spi-max-frequency: Definition as per
-		Documentation/devicetree/bindings/spi/spi-bus.txt
-
-Example:
-adc@0 {
-	compatible = "maxim,max1118";
-	reg = <0>;
-	vref-supply = <&vdd_supply>;
-	spi-max-frequency = <1000000>;
-};
diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max1118.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max1118.yaml
new file mode 100644
index 000000000000..ca24b8b23cde
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/maxim,max1118.yaml
@@ -0,0 +1,59 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/maxim,max1118.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX1118 and similar ADCs
+
+maintainers:
+  - Akinobu Mita <akinobu.mita@gmail.com>
+
+description: |
+    Dual channel 8bit ADCs.
+
+properties:
+  compatible:
+    enum:
+      - maxim,max1117
+      - maxim,max1118
+      - maxim,max1119
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency:
+    maximum: 5000000
+
+required:
+  - compatible
+  - reg
+
+allOf:
+  - if:
+      properties:
+        compatible:
+          contains:
+           const: maxim,max1118
+    then:
+      properties:
+        vref-supply:
+          description: External reference, needed to establish input scaling
+
+      required:
+        - vref-supply
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@0 {
+            compatible = "maxim,max1118";
+            reg = <0>;
+            vref-supply = <&adc_vref>;
+            spi-max-frequency = <1000000>;
+        };
+    };
+...