xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/regulator/fixed-regulator.yaml (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun# SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun%YAML 1.2
3*4882a593Smuzhiyun---
4*4882a593Smuzhiyun$id: http://devicetree.org/schemas/regulator/fixed-regulator.yaml#
5*4882a593Smuzhiyun$schema: http://devicetree.org/meta-schemas/core.yaml#
6*4882a593Smuzhiyun
7*4882a593Smuzhiyuntitle: Fixed Voltage regulators
8*4882a593Smuzhiyun
9*4882a593Smuzhiyunmaintainers:
10*4882a593Smuzhiyun  - Liam Girdwood <lgirdwood@gmail.com>
11*4882a593Smuzhiyun  - Mark Brown <broonie@kernel.org>
12*4882a593Smuzhiyun
13*4882a593Smuzhiyundescription:
14*4882a593Smuzhiyun  Any property defined as part of the core regulator binding, defined in
15*4882a593Smuzhiyun  regulator.yaml, can also be used. However a fixed voltage regulator is
16*4882a593Smuzhiyun  expected to have the regulator-min-microvolt and regulator-max-microvolt
17*4882a593Smuzhiyun  to be the same.
18*4882a593Smuzhiyun
19*4882a593SmuzhiyunallOf:
20*4882a593Smuzhiyun  - $ref: "regulator.yaml#"
21*4882a593Smuzhiyun
22*4882a593Smuzhiyunif:
23*4882a593Smuzhiyun  properties:
24*4882a593Smuzhiyun    compatible:
25*4882a593Smuzhiyun      contains:
26*4882a593Smuzhiyun        const: regulator-fixed-clock
27*4882a593Smuzhiyun  required:
28*4882a593Smuzhiyun    - clocks
29*4882a593Smuzhiyun
30*4882a593Smuzhiyunproperties:
31*4882a593Smuzhiyun  compatible:
32*4882a593Smuzhiyun    enum:
33*4882a593Smuzhiyun      - regulator-fixed
34*4882a593Smuzhiyun      - regulator-fixed-clock
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun  regulator-name: true
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun  gpio:
39*4882a593Smuzhiyun    description: gpio to use for enable control
40*4882a593Smuzhiyun    maxItems: 1
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun  clocks:
43*4882a593Smuzhiyun    description:
44*4882a593Smuzhiyun      clock to use for enable control. This binding is only available if
45*4882a593Smuzhiyun      the compatible is chosen to regulator-fixed-clock. The clock binding
46*4882a593Smuzhiyun      is mandatory if compatible is chosen to regulator-fixed-clock.
47*4882a593Smuzhiyun    maxItems: 1
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun  startup-delay-us:
50*4882a593Smuzhiyun    description: startup time in microseconds
51*4882a593Smuzhiyun    $ref: /schemas/types.yaml#/definitions/uint32
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun  off-on-delay-us:
54*4882a593Smuzhiyun    description: off delay time in microseconds
55*4882a593Smuzhiyun    $ref: /schemas/types.yaml#/definitions/uint32
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun  enable-active-high:
58*4882a593Smuzhiyun    description:
59*4882a593Smuzhiyun      Polarity of GPIO is Active high. If this property is missing,
60*4882a593Smuzhiyun      the default assumed is Active low.
61*4882a593Smuzhiyun    type: boolean
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun  gpio-open-drain:
64*4882a593Smuzhiyun    description:
65*4882a593Smuzhiyun      GPIO is open drain type. If this property is missing then default
66*4882a593Smuzhiyun      assumption is false.
67*4882a593Smuzhiyun    type: boolean
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun  vin-supply:
70*4882a593Smuzhiyun    description: Input supply phandle.
71*4882a593Smuzhiyun
72*4882a593Smuzhiyunrequired:
73*4882a593Smuzhiyun  - compatible
74*4882a593Smuzhiyun  - regulator-name
75*4882a593Smuzhiyun
76*4882a593SmuzhiyununevaluatedProperties: false
77*4882a593Smuzhiyun
78*4882a593Smuzhiyunexamples:
79*4882a593Smuzhiyun  - |
80*4882a593Smuzhiyun    reg_1v8: regulator-1v8 {
81*4882a593Smuzhiyun      compatible = "regulator-fixed";
82*4882a593Smuzhiyun      regulator-name = "1v8";
83*4882a593Smuzhiyun      regulator-min-microvolt = <1800000>;
84*4882a593Smuzhiyun      regulator-max-microvolt = <1800000>;
85*4882a593Smuzhiyun      gpio = <&gpio1 16 0>;
86*4882a593Smuzhiyun      startup-delay-us = <70000>;
87*4882a593Smuzhiyun      enable-active-high;
88*4882a593Smuzhiyun      regulator-boot-on;
89*4882a593Smuzhiyun      gpio-open-drain;
90*4882a593Smuzhiyun      vin-supply = <&parent_reg>;
91*4882a593Smuzhiyun    };
92*4882a593Smuzhiyun...
93