Merge branch 'for-linus' into next
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / regulator / fixed-regulator.yaml
1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/regulator/fixed-regulator.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Fixed Voltage regulators
8
9 maintainers:
10   - Liam Girdwood <lgirdwood@gmail.com>
11   - Mark Brown <broonie@kernel.org>
12
13 description:
14   Any property defined as part of the core regulator binding, defined in
15   regulator.txt, can also be used. However a fixed voltage regulator is
16   expected to have the regulator-min-microvolt and regulator-max-microvolt
17   to be the same.
18
19 properties:
20   compatible:
21     const: regulator-fixed
22
23   regulator-name: true
24
25   gpio:
26     description: gpio to use for enable control
27     maxItems: 1
28
29   startup-delay-us:
30     description: startup time in microseconds
31     $ref: /schemas/types.yaml#/definitions/uint32
32
33   enable-active-high:
34     description:
35       Polarity of GPIO is Active high. If this property is missing,
36       the default assumed is Active low.
37     type: boolean
38
39   gpio-open-drain:
40     description:
41       GPIO is open drain type. If this property is missing then default
42       assumption is false.
43     type: boolean
44
45   vin-supply:
46     description: Input supply phandle.
47     $ref: /schemas/types.yaml#/definitions/phandle
48
49 required:
50   - compatible
51   - regulator-name
52
53 examples:
54   - |
55     reg_1v8: regulator-1v8 {
56       compatible = "regulator-fixed";
57       regulator-name = "1v8";
58       regulator-min-microvolt = <1800000>;
59       regulator-max-microvolt = <1800000>;
60       gpio = <&gpio1 16 0>;
61       startup-delay-us = <70000>;
62       enable-active-high;
63       regulator-boot-on;
64       gpio-open-drain;
65       vin-supply = <&parent_reg>;
66     };
67 ...