GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / mfd / wm831x.txt
1 Cirrus Logic/Wolfson Microelectronics wm831x PMICs
2
3 System PMICs with a wide range of additional features.
4
5 Required properties:
6
7   - compatible : One of the following chip-specific strings:
8         "wlf,wm8310"
9         "wlf,wm8311"
10         "wlf,wm8312"
11         "wlf,wm8320"
12         "wlf,wm8321"
13         "wlf,wm8325"
14         "wlf,wm8326"
15
16   - reg : I2C slave address when connected using I2C, chip select number
17     when using SPI.
18
19   - gpio-controller : Indicates this device is a GPIO controller.
20   - #gpio-cells : Must be 2. The first cell is the pin number and the
21     second cell is used to specify optional parameters (currently unused).
22
23   - interrupts : The interrupt line the IRQ signal for the device is
24     connected to.
25   - interrupt-parent : The parent interrupt controller.
26
27   - interrupt-controller : wm831x devices contain interrupt controllers and
28     may provide interrupt services to other devices.
29   - #interrupt-cells: Must be 2. The first cell is the IRQ number, and the
30     second cell is the flags, encoded as the trigger masks from
31     ../interrupt-controller/interrupts.txt
32
33 Optional sub-nodes:
34   - phys : Contains a phandle to the USB PHY.
35   - regulators : Contains sub-nodes for each of the regulators supplied by
36     the device. The regulators are bound using their names listed below:
37
38     dcdc1 : DCDC1
39     dcdc2 : DCDC2
40     dcdc3 : DCDC3
41     dcdc4 : DCDC3
42     isink1 : ISINK1
43     isink2 : ISINK2
44     ldo1 : LDO1
45     ldo2 : LDO2
46     ldo3 : LDO3
47     ldo4 : LDO4
48     ldo5 : LDO5
49     ldo7 : LDO7
50     ldo11 : LDO11
51
52     The bindings details of each regulator can be found in:
53     ../regulator/regulator.txt
54
55 Example:
56
57 wm8310: pmic@36 {
58         compatible = "wlf,wm8310";
59         reg = <0x36>;
60
61         gpio-controller;
62         #gpio-cells = <2>;
63
64         interrupts = <347>;
65         interrupt-parent = <&gic>;
66
67         interrupt-controller;
68         #interrupt-cells = <2>;
69
70         regulators {
71                 dcdc1: dcdc1 {
72                         regulator-name = "DCDC1";
73                         regulator-min-microvolt = <600000>;
74                         regulator-max-microvolt = <600000>;
75                 };
76                 ldo1: ldo1 {
77                         regulator-name = "LDO1";
78                         regulator-min-microvolt = <1700000>;
79                         regulator-max-microvolt = <1700000>;
80                 };
81         };
82 };