Lines Matching +full:regulator +full:- +full:state +full:- +full:standby
1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * consumer.h -- SoC Regulator consumer support.
9 * Regulator Consumer Interface.
11 * A Power Management Regulator framework for SoC based devices.
12 * Features:-
15 * o Regulator status.
19 * Dynamic Regulator operating Mode Switching (DRMS) - allows regulators
23 * e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during
25 * idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA
26 * but this drops rapidly to 60% when below 100mA. Regulator r has > 90%
27 * efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate
36 #include <regulator/regulator.h>
44 * Regulator operating modes.
48 * best (and most efficient) regulator mode for a desired load.
51 * will probably not match the naming convention of your regulator data sheet
57 * FAST Regulator can handle fast changes in it's load.
61 * NORMAL Normal regulator power supply mode. Most drivers will
64 * IDLE Regulator runs in a more efficient mode for light
70 * STANDBY Regulator runs in the most efficient mode for very
72 * in a sleep/standby state. This mode is likely to be
89 * Regulator errors that can be queried using regulator_get_error_flags
91 * UNDER_VOLTAGE Regulator output is under voltage.
92 * OVER_CURRENT Regulator output current is too high.
93 * REGULATION_OUT Regulator output is out of regulation.
94 * FAIL Regulator output has failed.
95 * OVER_TEMP Regulator over temp.
112 * struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event
124 struct regulator;
127 * struct regulator_bulk_data - Data used for bulk regulator operations.
130 * using the bulk regulator APIs.
131 * @consumer: The regulator consumer for the supply. This will be managed
133 * @init_load_uA: After getting the regulator, regulator_set_load() will be
135 * using the bulk regulator APIs.
137 * The regulator APIs provide a series of regulator_bulk_() API calls as
143 struct regulator *consumer;
152 /* regulator get and put */
153 struct regulator *__must_check regulator_get(struct device *dev,
155 struct regulator *__must_check devm_regulator_get(struct device *dev,
157 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
159 struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
161 struct regulator *__must_check regulator_get_optional(struct device *dev,
163 struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
168 void regulator_put(struct regulator *regulator);
169 void devm_regulator_put(struct regulator *regulator);
194 /* regulator output control and status */
195 int __must_check regulator_enable(struct regulator *regulator);
196 int regulator_disable(struct regulator *regulator);
197 int regulator_force_disable(struct regulator *regulator);
198 int regulator_is_enabled(struct regulator *regulator);
199 int regulator_disable_deferred(struct regulator *regulator, int ms);
223 int regulator_count_voltages(struct regulator *regulator);
224 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
225 int regulator_is_supported_voltage(struct regulator *regulator,
227 unsigned int regulator_get_linear_step(struct regulator *regulator);
228 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
229 int regulator_set_voltage_time(struct regulator *regulator,
231 int regulator_get_voltage(struct regulator *regulator);
232 int regulator_sync_voltage(struct regulator *regulator);
233 int regulator_set_current_limit(struct regulator *regulator,
235 int regulator_get_current_limit(struct regulator *regulator);
236 int regulator_get_unclaimed_power_budget(struct regulator *regulator);
237 int regulator_request_power_budget(struct regulator *regulator,
239 void regulator_free_power_budget(struct regulator *regulator,
242 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
243 unsigned int regulator_get_mode(struct regulator *regulator);
244 int regulator_get_error_flags(struct regulator *regulator,
246 int regulator_set_load(struct regulator *regulator, int load_uA);
248 int regulator_allow_bypass(struct regulator *regulator, bool allow);
250 struct regmap *regulator_get_regmap(struct regulator *regulator);
251 int regulator_get_hardware_vsel_register(struct regulator *regulator,
254 int regulator_list_hardware_vsel(struct regulator *regulator,
256 int regulator_hardware_enable(struct regulator *regulator, bool enable);
258 /* regulator notifier block */
259 int regulator_register_notifier(struct regulator *regulator,
261 int devm_regulator_register_notifier(struct regulator *regulator,
263 int regulator_unregister_notifier(struct regulator *regulator,
265 void devm_regulator_unregister_notifier(struct regulator *regulator,
268 /* regulator suspend */
270 suspend_state_t state);
272 suspend_state_t state);
273 int regulator_set_suspend_voltage(struct regulator *regulator, int min_uV,
274 int max_uV, suspend_state_t state);
276 /* driver data - core doesn't touch */
277 void *regulator_get_drvdata(struct regulator *regulator);
278 void regulator_set_drvdata(struct regulator *regulator, void *data);
286 bool regulator_is_equal(struct regulator *reg1, struct regulator *reg2);
294 static inline struct regulator *__must_check regulator_get(struct device *dev, in regulator_get()
297 /* Nothing except the stubbed out regulator API should be in regulator_get()
300 * skipping all regulator API calls, but they don't have to. in regulator_get()
308 static inline struct regulator *__must_check
314 static inline struct regulator *__must_check
317 return ERR_PTR(-ENODEV); in regulator_get_exclusive()
320 static inline struct regulator *__must_check
323 return ERR_PTR(-ENODEV); in devm_regulator_get_exclusive()
340 return -ENODEV; in devm_regulator_get_enable_read_voltage()
343 static inline struct regulator *__must_check
346 return ERR_PTR(-ENODEV); in regulator_get_optional()
350 static inline struct regulator *__must_check
353 return ERR_PTR(-ENODEV); in devm_regulator_get_optional()
356 static inline void regulator_put(struct regulator *regulator) in regulator_put() argument
360 static inline void devm_regulator_put(struct regulator *regulator) in devm_regulator_put() argument
413 static inline int regulator_enable(struct regulator *regulator) in regulator_enable() argument
418 static inline int regulator_disable(struct regulator *regulator) in regulator_disable() argument
423 static inline int regulator_force_disable(struct regulator *regulator) in regulator_force_disable() argument
428 static inline int regulator_disable_deferred(struct regulator *regulator, in regulator_disable_deferred() argument
434 static inline int regulator_is_enabled(struct regulator *regulator) in regulator_is_enabled() argument
490 static inline int regulator_set_voltage(struct regulator *regulator, in regulator_set_voltage() argument
496 static inline int regulator_set_voltage_time(struct regulator *regulator, in regulator_set_voltage_time() argument
502 static inline int regulator_get_voltage(struct regulator *regulator) in regulator_get_voltage() argument
504 return -EINVAL; in regulator_get_voltage()
507 static inline int regulator_sync_voltage(struct regulator *regulator) in regulator_sync_voltage() argument
509 return -EINVAL; in regulator_sync_voltage()
512 static inline int regulator_is_supported_voltage(struct regulator *regulator, in regulator_is_supported_voltage() argument
518 static inline unsigned int regulator_get_linear_step(struct regulator *regulator) in regulator_get_linear_step() argument
523 static inline int regulator_set_current_limit(struct regulator *regulator, in regulator_set_current_limit() argument
529 static inline int regulator_get_current_limit(struct regulator *regulator) in regulator_get_current_limit() argument
534 static inline int regulator_get_unclaimed_power_budget(struct regulator *regulator) in regulator_get_unclaimed_power_budget() argument
539 static inline int regulator_request_power_budget(struct regulator *regulator, in regulator_request_power_budget() argument
542 return -EOPNOTSUPP; in regulator_request_power_budget()
545 static inline void regulator_free_power_budget(struct regulator *regulator, in regulator_free_power_budget() argument
550 static inline int regulator_set_mode(struct regulator *regulator, in regulator_set_mode() argument
556 static inline unsigned int regulator_get_mode(struct regulator *regulator) in regulator_get_mode() argument
561 static inline int regulator_get_error_flags(struct regulator *regulator, in regulator_get_error_flags() argument
564 return -EINVAL; in regulator_get_error_flags()
567 static inline int regulator_set_load(struct regulator *regulator, int load_uA) in regulator_set_load() argument
572 static inline int regulator_allow_bypass(struct regulator *regulator, in regulator_allow_bypass() argument
578 static inline struct regmap *regulator_get_regmap(struct regulator *regulator) in regulator_get_regmap() argument
580 return ERR_PTR(-EOPNOTSUPP); in regulator_get_regmap()
583 static inline int regulator_get_hardware_vsel_register(struct regulator *regulator, in regulator_get_hardware_vsel_register() argument
587 return -EOPNOTSUPP; in regulator_get_hardware_vsel_register()
590 static inline int regulator_list_hardware_vsel(struct regulator *regulator, in regulator_list_hardware_vsel() argument
593 return -EOPNOTSUPP; in regulator_list_hardware_vsel()
596 static inline int regulator_hardware_enable(struct regulator *regulator, in regulator_hardware_enable() argument
599 return -EOPNOTSUPP; in regulator_hardware_enable()
602 static inline int regulator_register_notifier(struct regulator *regulator, in regulator_register_notifier() argument
608 static inline int devm_regulator_register_notifier(struct regulator *regulator, in devm_regulator_register_notifier() argument
614 static inline int regulator_unregister_notifier(struct regulator *regulator, in regulator_unregister_notifier() argument
620 static inline int devm_regulator_unregister_notifier(struct regulator *regulator, in devm_regulator_unregister_notifier() argument
627 suspend_state_t state) in regulator_suspend_enable() argument
629 return -EINVAL; in regulator_suspend_enable()
633 suspend_state_t state) in regulator_suspend_disable() argument
635 return -EINVAL; in regulator_suspend_disable()
638 static inline int regulator_set_suspend_voltage(struct regulator *regulator, in regulator_set_suspend_voltage() argument
640 suspend_state_t state) in regulator_set_suspend_voltage() argument
642 return -EINVAL; in regulator_set_suspend_voltage()
645 static inline void *regulator_get_drvdata(struct regulator *regulator) in regulator_get_drvdata() argument
650 static inline void regulator_set_drvdata(struct regulator *regulator, in regulator_set_drvdata() argument
655 static inline int regulator_count_voltages(struct regulator *regulator) in regulator_count_voltages() argument
660 static inline int regulator_list_voltage(struct regulator *regulator, unsigned selector) in regulator_list_voltage() argument
662 return -EINVAL; in regulator_list_voltage()
673 regulator_is_equal(struct regulator *reg1, struct regulator *reg2) in regulator_is_equal()
680 struct regulator *__must_check of_regulator_get_optional(struct device *dev,
683 struct regulator *__must_check devm_of_regulator_get_optional(struct device *dev,
689 static inline struct regulator *__must_check of_regulator_get_optional(struct device *dev, in of_regulator_get_optional()
693 return ERR_PTR(-ENODEV); in of_regulator_get_optional()
696 static inline struct regulator *__must_check devm_of_regulator_get_optional(struct device *dev, in devm_of_regulator_get_optional()
700 return ERR_PTR(-ENODEV); in devm_of_regulator_get_optional()
711 static inline int regulator_set_voltage_triplet(struct regulator *regulator, in regulator_set_voltage_triplet() argument
715 if (regulator_set_voltage(regulator, target_uV, max_uV) == 0) in regulator_set_voltage_triplet()
718 return regulator_set_voltage(regulator, min_uV, max_uV); in regulator_set_voltage_triplet()
721 static inline int regulator_set_voltage_tol(struct regulator *regulator, in regulator_set_voltage_tol() argument
724 if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0) in regulator_set_voltage_tol()
727 return regulator_set_voltage(regulator, in regulator_set_voltage_tol()
728 new_uV - tol_uV, new_uV + tol_uV); in regulator_set_voltage_tol()
731 static inline int regulator_is_supported_voltage_tol(struct regulator *regulator, in regulator_is_supported_voltage_tol() argument
734 return regulator_is_supported_voltage(regulator, in regulator_is_supported_voltage_tol()
735 target_uV - tol_uV, in regulator_is_supported_voltage_tol()