dt-bindings/regulator/qcom%2Crpmh-regulator.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /* Copyright (c) 2018, The Linux Foundation. All rights reserved. */
0003
0004 #ifndef __QCOM_RPMH_REGULATOR_H
0005 #define __QCOM_RPMH_REGULATOR_H
0006
0007 /*
0008  * These mode constants may be used to specify modes for various RPMh regulator
0009  * device tree properties (e.g. regulator-initial-mode).  Each type of regulator
0010  * supports a subset of the possible modes.
0011  *
0012  * %RPMH_REGULATOR_MODE_RET:    Retention mode in which only an extremely small
0013  *              load current is allowed.  This mode is supported
0014  *              by LDO and SMPS type regulators.
0015  * %RPMH_REGULATOR_MODE_LPM:    Low power mode in which a small load current is
0016  *              allowed.  This mode corresponds to PFM for SMPS
0017  *              and BOB type regulators.  This mode is supported
0018  *              by LDO, HFSMPS, BOB, and PMIC4 FTSMPS type
0019  *              regulators.
0020  * %RPMH_REGULATOR_MODE_AUTO:   Auto mode in which the regulator hardware
0021  *              automatically switches between LPM and HPM based
0022  *              upon the real-time load current.  This mode is
0023  *              supported by HFSMPS, BOB, and PMIC4 FTSMPS type
0024  *              regulators.
0025  * %RPMH_REGULATOR_MODE_HPM:    High power mode in which the full rated current
0026  *              of the regulator is allowed.  This mode
0027  *              corresponds to PWM for SMPS and BOB type
0028  *              regulators.  This mode is supported by all types
0029  *              of regulators.
0030  */
0031 #define RPMH_REGULATOR_MODE_RET     0
0032 #define RPMH_REGULATOR_MODE_LPM     1
0033 #define RPMH_REGULATOR_MODE_AUTO    2
0034 #define RPMH_REGULATOR_MODE_HPM     3
0035
0036 #endif