Re: [PATCH 36/46] dt-bindings:iio:adc:qcom,spmi-iadc: txt to yaml format conversion.

[Jonathan Cameron <jic23@kernel.org>]

On Sat, 31 Oct 2020 18:48:44 +0000
Jonathan Cameron <jic23@kernel.org> wrote:

> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> Straight forward conversion.  Not heard from Ivan in a while so if the
> email bounces, I'll change the maintainer to myself for this binding unless
> anyone else comes forwards.
> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Ivan T. Ivanov <iivanov@mm-sol.com>
Ivan's email is bouncing, so I've put myself as temporary maintainer
on this one until someone else steps up.

Otherwise, dropped $ref for standard unit case -ohms as suggested by RobH.

Applied to the togreg branch of iio.git and pushed out as testing for
all the normal reasons.

Thanks,

Jonathan

> ---
>  .../bindings/iio/adc/qcom,spmi-iadc.txt       | 46 --------------
>  .../bindings/iio/adc/qcom,spmi-iadc.yaml      | 62 +++++++++++++++++++
>  2 files changed, 62 insertions(+), 46 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/qcom,spmi-iadc.txt b/Documentation/devicetree/bindings/iio/adc/qcom,spmi-iadc.txt
> deleted file mode 100644
> index 4e36d6e2f7b6..000000000000
> --- a/Documentation/devicetree/bindings/iio/adc/qcom,spmi-iadc.txt
> +++ /dev/null
> @@ -1,46 +0,0 @@
> -Qualcomm's SPMI PMIC current ADC
> -
> -QPNP PMIC current ADC (IADC) provides interface to clients to read current.
> -A 16 bit ADC is used for current measurements. IADC can measure the current
> -through an external resistor (channel 1) or internal (built-in) resistor
> -(channel 0). When using an external resistor it is to be described by
> -qcom,external-resistor-micro-ohms property.
> -
> -IADC node:
> -
> -- compatible:
> -    Usage: required
> -    Value type: <string>
> -    Definition: Should contain "qcom,spmi-iadc".
> -
> -- reg:
> -    Usage: required
> -    Value type: <prop-encoded-array>
> -    Definition: IADC base address and length in the SPMI PMIC register map
> -
> -- interrupts:
> -    Usage: optional
> -    Value type: <prop-encoded-array>
> -    Definition: End of ADC conversion.
> -
> -- qcom,external-resistor-micro-ohms:
> -    Usage: optional
> -    Value type: <u32>
> -    Definition: Sense resister value in micro Ohm.
> -                If not defined value of 10000 micro Ohms will be used.
> -
> -Example:
> -	/* IADC node */
> -	pmic_iadc: iadc@3600 {
> -		compatible = "qcom,spmi-iadc";
> -		reg = <0x3600 0x100>;
> -		interrupts = <0x0 0x36 0x0 IRQ_TYPE_EDGE_RISING>;
> -		qcom,external-resistor-micro-ohms = <10000>;
> -		#io-channel-cells  = <1>;
> -	};
> -
> -	/* IIO client node */
> -	bat {
> -		io-channels = <&pmic_iadc  0>;
> -		io-channel-names = "iadc";
> -	};
> diff --git a/Documentation/devicetree/bindings/iio/adc/qcom,spmi-iadc.yaml b/Documentation/devicetree/bindings/iio/adc/qcom,spmi-iadc.yaml
> new file mode 100644
> index 000000000000..359e1ede0ae2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/qcom,spmi-iadc.yaml
> @@ -0,0 +1,62 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/qcom,spmi-iadc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Qualcomm's SPMI PMIC current ADC
> +
> +maintainers:
> +  - Ivan T. Ivanov <iivanov@mm-sol.com>
> +
> +description: |
> +  QPNP PMIC current ADC (IADC) provides interface to clients to read current.
> +  A 16 bit ADC is used for current measurements. IADC can measure the current
> +  through an external resistor (channel 1) or internal (built-in) resistor
> +  (channel 0). When using an external resistor it is to be described by
> +  qcom,external-resistor-micro-ohms property.
> +
> +properties:
> +  compatible:
> +    const: qcom,spmi-iadc
> +
> +  reg:
> +    description: IADC base address and length in the SPMI PMIC register map
> +    maxItems: 1
> +
> +  qcom,external-resistor-micro-ohms:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description:
> +      Sensor resistor value. If not defined value of 10000 micro Ohms
> +      will be used.
> +
> +  interrupts:
> +    maxItems: 1
> +    description:
> +      End of conversion interrupt.
> +
> +  "#io-channel-cells":
> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    spmi_bus {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +        pmic_iadc: adc@3600 {
> +            compatible = "qcom,spmi-iadc";
> +            reg = <0x3600 0x100>;
> +            interrupts = <0x0 0x36 0x0 IRQ_TYPE_EDGE_RISING>;
> +            qcom,external-resistor-micro-ohms = <10000>;
> +            #io-channel-cells  = <1>;
> +        };
> +    };
> +...
> +