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.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
  19 allOf:
  20   - $ref: "regulator.yaml#"
  21
  22 if:
  23   properties:
  24     compatible:
  25       contains:
  26         const: regulator-fixed-clock
  27   required:
  28     - clocks
  29
  30 properties:
  31   compatible:
  32     enum:
  33       - const: regulator-fixed
  34       - const: 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   enable-active-high:
  54     description:
  55       Polarity of GPIO is Active high. If this property is missing,
  56       the default assumed is Active low.
  57     type: boolean
  58
  59   gpio-open-drain:
  60     description:
  61       GPIO is open drain type. If this property is missing then default
  62       assumption is false.
  63     type: boolean
  64
  65   vin-supply:
  66     description: Input supply phandle.
  67     $ref: /schemas/types.yaml#/definitions/phandle
  68
  69 required:
  70   - compatible
  71   - regulator-name
  72
  73 examples:
  74   - |
  75     reg_1v8: regulator-1v8 {
  76       compatible = "regulator-fixed";
  77       regulator-name = "1v8";
  78       regulator-min-microvolt = <1800000>;
  79       regulator-max-microvolt = <1800000>;
  80       gpio = <&gpio1 16 0>;
  81       startup-delay-us = <70000>;
  82       enable-active-high;
  83       regulator-boot-on;
  84       gpio-open-drain;
  85       vin-supply = <&parent_reg>;
  86     };
  87 ...