xref: /linux/Documentation/devicetree/bindings/regulator/rohm,pmic-states.yaml (revision b3438e5ca785565a65ef231bc03cd5a05c3be5c7)
1*f29a8bf6SMatti Vaittinen# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2*f29a8bf6SMatti Vaittinen%YAML 1.2
3*f29a8bf6SMatti Vaittinen---
4*f29a8bf6SMatti Vaittinen$id: http://devicetree.org/schemas/regulator/rohm,pmic-states.yaml#
5*f29a8bf6SMatti Vaittinen$schema: http://devicetree.org/meta-schemas/core.yaml#
6*f29a8bf6SMatti Vaittinen
7*f29a8bf6SMatti Vaittinentitle: ROHM PMICs' hardware state machine descriptions
8*f29a8bf6SMatti Vaittinen
9*f29a8bf6SMatti Vaittinenmaintainers:
10*f29a8bf6SMatti Vaittinen  - Matti Vaittinen <mazziesaccount@gmail.com>
11*f29a8bf6SMatti Vaittinen
12*f29a8bf6SMatti Vaittinendescription:
13*f29a8bf6SMatti Vaittinen  Many of the ROHM PMICs have internal state-machine designed to provide
14*f29a8bf6SMatti Vaittinen  correct voltages for different SOC states. In many cases the states and
15*f29a8bf6SMatti Vaittinen  transitions are SOC specific, but ones described here can be found from a
16*f29a8bf6SMatti Vaittinen  few of the different ROHM PMICs.
17*f29a8bf6SMatti Vaittinen
18*f29a8bf6SMatti Vaittinenproperties:
19*f29a8bf6SMatti Vaittinen  rohm,dvs-run-voltage:
20*f29a8bf6SMatti Vaittinen    description:
21*f29a8bf6SMatti Vaittinen      PMIC "RUN" state voltage in uV when PMIC HW states are used. 0 means the
22*f29a8bf6SMatti Vaittinen      regulator should be disabled at RUN state. Some regulators do not support
23*f29a8bf6SMatti Vaittinen      setting HW state specific voltage but do support enable/disable control.
24*f29a8bf6SMatti Vaittinen      For them any positive value means the regulator should be enabled without
25*f29a8bf6SMatti Vaittinen      touching the voltage.
26*f29a8bf6SMatti Vaittinen    $ref: /schemas/types.yaml#/definitions/uint32
27*f29a8bf6SMatti Vaittinen
28*f29a8bf6SMatti Vaittinen  rohm,dvs-suspend-voltage:
29*f29a8bf6SMatti Vaittinen    description:
30*f29a8bf6SMatti Vaittinen      PMIC "SUSPEND" state voltage in uV when PMIC HW states are used. 0 means
31*f29a8bf6SMatti Vaittinen      the regulator should be disabled at SUSPEND state. Some regulators do not
32*f29a8bf6SMatti Vaittinen      support setting HW state specific voltage but do support enable/disable
33*f29a8bf6SMatti Vaittinen      control. For them any positive value means the regulator should be
34*f29a8bf6SMatti Vaittinen      enabled without touching the voltage.
35*f29a8bf6SMatti Vaittinen    $ref: /schemas/types.yaml#/definitions/uint32
36*f29a8bf6SMatti Vaittinen
37*f29a8bf6SMatti Vaittinen  rohm,dvs-idle-voltage:
38*f29a8bf6SMatti Vaittinen    description:
39*f29a8bf6SMatti Vaittinen      PMIC "IDLE" state voltage in uV. 0 means the regulator should be disabled
40*f29a8bf6SMatti Vaittinen      at IDLE state. Some regulators do not support setting HW state specific
41*f29a8bf6SMatti Vaittinen      voltage but do support enable/disable control. For them any positive
42*f29a8bf6SMatti Vaittinen      value means the regulator should be enabled without touching the voltage.
43*f29a8bf6SMatti Vaittinen    $ref: /schemas/types.yaml#/definitions/uint32
44*f29a8bf6SMatti Vaittinen
45*f29a8bf6SMatti Vaittinen  rohm,dvs-lpsr-voltage:
46*f29a8bf6SMatti Vaittinen    description:
47*f29a8bf6SMatti Vaittinen      PMIC "LPSR" state voltage in uV when PMIC HW states are used. 0 means the
48*f29a8bf6SMatti Vaittinen      regulator should be disabled at LPSR state. Some regulators do not
49*f29a8bf6SMatti Vaittinen      support setting HW state specific voltage but do support enable/disable
50*f29a8bf6SMatti Vaittinen      control. For them any positive value means the regulator should be
51*f29a8bf6SMatti Vaittinen      enabled without touching the voltage. Some PMICs' documentation may refer
52*f29a8bf6SMatti Vaittinen      to this state as a "deep-idle state".
53*f29a8bf6SMatti Vaittinen    $ref: /schemas/types.yaml#/definitions/uint32
54*f29a8bf6SMatti Vaittinen
55*f29a8bf6SMatti Vaittinen# The schema is expected to be reference by PMIC schemas, which may introduce
56*f29a8bf6SMatti Vaittinen# other properties that must be allowed.
57*f29a8bf6SMatti VaittinenadditionalProperties: true
58