xref: /linux/Documentation/devicetree/bindings/regulator/maxim,max77620-regulator.yaml (revision 44f7a3795395b54bf674002803e3e80c6312e210)
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/regulator/maxim,max77620-regulator.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Regulator for MAX77620 Power management IC from Maxim Semiconductor.
8
9maintainers:
10  - Svyatoslav Ryhel <clamor95@gmail.com>
11
12description:
13  Device has multiple DCDC(sd[0-3]) and LDOs(ldo[0-8]). The input supply
14  of these regulators are defined under parent device node. Details of
15  regulator properties are defined as child node under sub-node "regulators"
16  which is child node of device node.
17
18patternProperties:
19  "^in-(sd[0-3]|ldo(0-1|2|3-5|4-6|7-8))-supply$":
20    $ref: /schemas/types.yaml#/definitions/phandle
21    description: Input supply for DCDC or LDO
22
23  "^(sd[0-3]|ldo[0-8])$":
24    type: object
25    $ref: /schemas/regulator/regulator.yaml#
26    unevaluatedProperties: false
27
28    properties:
29      maxim,active-fps-source:
30        $ref: /schemas/types.yaml#/definitions/uint32
31        description: |
32          FPS source for the GPIOs to get enabled/disabled when system is in
33          active state. Valid values are:
34          - MAX77620_FPS_SRC_0: FPS source is FPS0.
35          - MAX77620_FPS_SRC_1: FPS source is FPS1
36          - MAX77620_FPS_SRC_2: FPS source is FPS2
37          - MAX77620_FPS_SRC_NONE: GPIO is not controlled by FPS events and
38                                   it gets enabled/disabled by register access.
39          Absence of this property will leave the FPS configuration register
40          for that GPIO to default configuration.
41
42      maxim,active-fps-power-up-slot:
43        $ref: /schemas/types.yaml#/definitions/uint32
44        description:
45          Sequencing event slot number on which the GPIO get enabled when
46          master FPS input event set to HIGH. This is applicable if FPS source
47          is selected as FPS0, FPS1 or FPS2.
48        enum: [0, 1, 2, 3, 4, 5, 6, 7]
49
50      maxim,active-fps-power-down-slot:
51        $ref: /schemas/types.yaml#/definitions/uint32
52        description:
53          Sequencing event slot number on which the GPIO get disabled when
54          master FPS input event set to LOW. This is applicable if FPS source
55          is selected as FPS0, FPS1 or FPS2.
56        enum: [0, 1, 2, 3, 4, 5, 6, 7]
57
58      maxim,suspend-fps-source:
59        $ref: /schemas/types.yaml#/definitions/uint32
60        description:
61          This is same as property "maxim,active-fps-source" but value get
62          configured when system enters in to suspend state.
63
64      maxim,suspend-fps-power-up-slot:
65        $ref: /schemas/types.yaml#/definitions/uint32
66        description:
67          This is same as property "maxim,active-fps-power-up-slot" but this
68          value get configured into FPS configuration register when system
69          enters into suspend. This is applicable if suspend state FPS source
70          is selected as FPS0, FPS1 or FPS2.
71        enum: [0, 1, 2, 3, 4, 5, 6, 7]
72
73      maxim,suspend-fps-power-down-slot:
74        $ref: /schemas/types.yaml#/definitions/uint32
75        description:
76          This is same as property "maxim,active-fps-power-down-slot" but this
77          value get configured into FPS configuration register when system
78          enters into suspend. This is applicable if suspend state FPS source
79          is selected as FPS0, FPS1 or FPS2.
80        enum: [0, 1, 2, 3, 4, 5, 6, 7]
81
82      maxim,ramp-rate-setting:
83        $ref: /schemas/types.yaml#/definitions/uint32
84        description: |
85          Ramp rate(uV/us) setting to be configured to the device. The platform
86          may have different ramp rate than advertised ramp rate if it has design
87          variation from Maxim's recommended. On this case, platform specific
88          ramp rate is used for ramp time calculation and this property is used
89          for device register configurations. The measured ramp rate of platform
90          is provided by the regulator-ramp-delay.
91
92          Maxim Max77620 supports following ramp delay:
93            SD: 13.75mV/us, 27.5mV/us, 55mV/us
94            LDOs: 5mV/us, 100mV/us
95        enum: [5000, 13750, 27500, 55000, 100000]
96
97additionalProperties: false
98
99# see maxim,max77620.yaml for an example
100