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

dt-bindings:iio:adc:qcom,spmi-iadc: txt to yaml format conversion.



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: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20201031184854.745828-37-jic23@kernel.org
parent 8d966b58
Loading
Loading
Loading
Loading
+0 −46
Original line number Diff line number Diff line
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";
	};
+60 −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/adc/qcom,spmi-iadc.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Qualcomm's SPMI PMIC current ADC

maintainers:
  - Jonathan Cameron <jic23@kernel.org>

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:
    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>;
        };
    };
...