xref: /linux/Documentation/devicetree/bindings/iio/adc/qcom,spmi-iadc.yaml (revision 0d3b051adbb72ed81956447d0d1e54d5943ee6f5)
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/iio/adc/qcom,spmi-iadc.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Qualcomm's SPMI PMIC current ADC
8
9maintainers:
10  - Jonathan Cameron <jic23@kernel.org>
11
12description: |
13  QPNP PMIC current ADC (IADC) provides interface to clients to read current.
14  A 16 bit ADC is used for current measurements. IADC can measure the current
15  through an external resistor (channel 1) or internal (built-in) resistor
16  (channel 0). When using an external resistor it is to be described by
17  qcom,external-resistor-micro-ohms property.
18
19properties:
20  compatible:
21    const: qcom,spmi-iadc
22
23  reg:
24    description: IADC base address and length in the SPMI PMIC register map
25    maxItems: 1
26
27  qcom,external-resistor-micro-ohms:
28    description:
29      Sensor resistor value. If not defined value of 10000 micro Ohms
30      will be used.
31
32  interrupts:
33    maxItems: 1
34    description:
35      End of conversion interrupt.
36
37  "#io-channel-cells":
38    const: 1
39
40required:
41  - compatible
42  - reg
43
44additionalProperties: false
45
46examples:
47  - |
48    #include <dt-bindings/interrupt-controller/irq.h>
49    spmi_bus {
50        #address-cells = <1>;
51        #size-cells = <0>;
52        pmic_iadc: adc@3600 {
53            compatible = "qcom,spmi-iadc";
54            reg = <0x3600 0x100>;
55            interrupts = <0x0 0x36 0x0 IRQ_TYPE_EDGE_RISING>;
56            qcom,external-resistor-micro-ohms = <10000>;
57            #io-channel-cells  = <1>;
58        };
59    };
60...
61