xref: /freebsd/sys/contrib/device-tree/Bindings/iio/adc/qcom,spmi-iadc.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1Qualcomm's SPMI PMIC current ADC
2
3QPNP PMIC current ADC (IADC) provides interface to clients to read current.
4A 16 bit ADC is used for current measurements. IADC can measure the current
5through an external resistor (channel 1) or internal (built-in) resistor
6(channel 0). When using an external resistor it is to be described by
7qcom,external-resistor-micro-ohms property.
8
9IADC node:
10
11- compatible:
12    Usage: required
13    Value type: <string>
14    Definition: Should contain "qcom,spmi-iadc".
15
16- reg:
17    Usage: required
18    Value type: <prop-encoded-array>
19    Definition: IADC base address and length in the SPMI PMIC register map
20
21- interrupts:
22    Usage: optional
23    Value type: <prop-encoded-array>
24    Definition: End of ADC conversion.
25
26- qcom,external-resistor-micro-ohms:
27    Usage: optional
28    Value type: <u32>
29    Definition: Sense resister value in micro Ohm.
30                If not defined value of 10000 micro Ohms will be used.
31
32Example:
33	/* IADC node */
34	pmic_iadc: iadc@3600 {
35		compatible = "qcom,spmi-iadc";
36		reg = <0x3600 0x100>;
37		interrupts = <0x0 0x36 0x0 IRQ_TYPE_EDGE_RISING>;
38		qcom,external-resistor-micro-ohms = <10000>;
39		#io-channel-cells  = <1>;
40	};
41
42	/* IIO client node */
43	bat {
44		io-channels = <&pmic_iadc  0>;
45		io-channel-names = "iadc";
46	};
47