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