xref: /linux/Documentation/devicetree/bindings/regulator/fixed-regulator.yaml (revision e5a52fd2b8cdb700b3c07b030e050a49ef3156b9) 
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
7title: Fixed Voltage regulators
8
9maintainers:
10  - Liam Girdwood <lgirdwood@gmail.com>
11  - Mark Brown <broonie@kernel.org>
12
13description:
14  Any property defined as part of the core regulator binding, defined in
15  regulator.yaml, 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
19allOf:
20  - $ref: "regulator.yaml#"
21
22if:
23  properties:
24    compatible:
25      contains:
26        const: regulator-fixed-clock
27  required:
28    - clocks
29
30properties:
31  compatible:
32    enum:
33      - regulator-fixed
34      - regulator-fixed-clock
35
36  regulator-name: true
37
38  gpio:
39    description: gpio to use for enable control
40    maxItems: 1
41
42  clocks:
43    description:
44      clock to use for enable control. This binding is only available if
45      the compatible is chosen to regulator-fixed-clock. The clock binding
46      is mandatory if compatible is chosen to regulator-fixed-clock.
47    maxItems: 1
48
49  startup-delay-us:
50    description: startup time in microseconds
51    $ref: /schemas/types.yaml#/definitions/uint32
52
53  off-on-delay-us:
54    description: off delay time in microseconds
55    $ref: /schemas/types.yaml#/definitions/uint32
56
57  enable-active-high:
58    description:
59      Polarity of GPIO is Active high. If this property is missing,
60      the default assumed is Active low.
61    type: boolean
62
63  gpio-open-drain:
64    description:
65      GPIO is open drain type. If this property is missing then default
66      assumption is false.
67    type: boolean
68
69  vin-supply:
70    description: Input supply phandle.
71
72required:
73  - compatible
74  - regulator-name
75
76examples:
77  - |
78    reg_1v8: regulator-1v8 {
79      compatible = "regulator-fixed";
80      regulator-name = "1v8";
81      regulator-min-microvolt = <1800000>;
82      regulator-max-microvolt = <1800000>;
83      gpio = <&gpio1 16 0>;
84      startup-delay-us = <70000>;
85      enable-active-high;
86      regulator-boot-on;
87      gpio-open-drain;
88      vin-supply = <&parent_reg>;
89    };
90...
91