xref: /freebsd/sys/contrib/device-tree/Bindings/mfd/qcom,spmi-pmic.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1          Qualcomm SPMI PMICs multi-function device bindings
2
3The Qualcomm SPMI series presently includes PM8941, PM8841 and PMA8084
4PMICs.  These PMICs use a QPNP scheme through SPMI interface.
5QPNP is effectively a partitioning scheme for dividing the SPMI extended
6register space up into logical pieces, and set of fixed register
7locations/definitions within these regions, with some of these regions
8specifically used for interrupt handling.
9
10The QPNP PMICs are used with the Qualcomm Snapdragon series SoCs, and are
11interfaced to the chip via the SPMI (System Power Management Interface) bus.
12Support for multiple independent functions are implemented by splitting the
1316-bit SPMI slave address space into 256 smaller fixed-size regions, 256 bytes
14each. A function can consume one or more of these fixed-size register regions.
15
16Required properties:
17- compatible:      Should contain one of:
18                   "qcom,pm8941",
19                   "qcom,pm8841",
20                   "qcom,pma8084",
21                   "qcom,pm8019",
22                   "qcom,pm8226",
23                   "qcom,pm8110",
24                   "qcom,pma8084",
25                   "qcom,pmi8962",
26                   "qcom,pmd9635",
27                   "qcom,pm8994",
28                   "qcom,pmi8994",
29                   "qcom,pm8916",
30                   "qcom,pm8004",
31                   "qcom,pm8909",
32                   "qcom,pm8950",
33                   "qcom,pmi8950",
34                   "qcom,pm8998",
35                   "qcom,pmi8998",
36                   "qcom,pm8005",
37                   or generalized "qcom,spmi-pmic".
38- reg:             Specifies the SPMI USID slave address for this device.
39                   For more information see:
40                   Documentation/devicetree/bindings/spmi/spmi.txt
41
42Required properties for peripheral child nodes:
43- compatible:      Should contain "qcom,xxx", where "xxx" is a peripheral name.
44
45Optional properties for peripheral child nodes:
46- interrupts:      Interrupts are specified as a 4-tuple. For more information
47                   see:
48                   Documentation/devicetree/bindings/spmi/qcom,spmi-pmic-arb.txt
49- interrupt-names: Corresponding interrupt name to the interrupts property
50
51Each child node of SPMI slave id represents a function of the PMIC. In the
52example below the rtc device node represents a peripheral of pm8941
53SID = 0. The regulator device node represents a peripheral of pm8941 SID = 1.
54
55Example:
56
57	spmi {
58		compatible = "qcom,spmi-pmic-arb";
59
60		pm8941@0 {
61			compatible = "qcom,pm8941", "qcom,spmi-pmic";
62			reg = <0x0 SPMI_USID>;
63
64			rtc {
65				compatible = "qcom,rtc";
66				interrupts = <0x0 0x61 0x1 IRQ_TYPE_EDGE_RISING>;
67				interrupt-names = "alarm";
68			};
69		};
70
71		pm8941@1 {
72			compatible = "qcom,pm8941", "qcom,spmi-pmic";
73			reg = <0x1 SPMI_USID>;
74
75			regulator {
76				compatible = "qcom,regulator";
77				regulator-name = "8941_boost";
78			};
79		};
80	};
81