1 // SPDX-License-Identifier: GPL-2.0-or-later
3 // helpers.c -- Voltage/Current Regulator framework helper functions.
5 // Copyright 2007, 2008 Wolfson Microelectronics PLC.
6 // Copyright 2008 SlimLogic Ltd.
8 #include <linux/kernel.h>
10 #include <linux/delay.h>
11 #include <linux/regmap.h>
12 #include <linux/regulator/consumer.h>
13 #include <linux/regulator/driver.h>
14 #include <linux/module.h>
17 * regulator_is_enabled_regmap - standard is_enabled() for regmap users
19 * @rdev: regulator to operate on
21 * Regulators that use regmap for their register I/O can set the
22 * enable_reg and enable_mask fields in their descriptor and then use
23 * this as their is_enabled operation, saving some code.
25 int regulator_is_enabled_regmap(struct regulator_dev *rdev)
30 ret = regmap_read(rdev->regmap, rdev->desc->enable_reg, &val);
34 val &= rdev->desc->enable_mask;
36 if (rdev->desc->enable_is_inverted) {
37 if (rdev->desc->enable_val)
38 return val != rdev->desc->enable_val;
41 if (rdev->desc->enable_val)
42 return val == rdev->desc->enable_val;
46 EXPORT_SYMBOL_GPL(regulator_is_enabled_regmap);
49 * regulator_enable_regmap - standard enable() for regmap users
51 * @rdev: regulator to operate on
53 * Regulators that use regmap for their register I/O can set the
54 * enable_reg and enable_mask fields in their descriptor and then use
55 * this as their enable() operation, saving some code.
57 int regulator_enable_regmap(struct regulator_dev *rdev)
61 if (rdev->desc->enable_is_inverted) {
62 val = rdev->desc->disable_val;
64 val = rdev->desc->enable_val;
66 val = rdev->desc->enable_mask;
69 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
70 rdev->desc->enable_mask, val);
72 EXPORT_SYMBOL_GPL(regulator_enable_regmap);
75 * regulator_disable_regmap - standard disable() for regmap users
77 * @rdev: regulator to operate on
79 * Regulators that use regmap for their register I/O can set the
80 * enable_reg and enable_mask fields in their descriptor and then use
81 * this as their disable() operation, saving some code.
83 int regulator_disable_regmap(struct regulator_dev *rdev)
87 if (rdev->desc->enable_is_inverted) {
88 val = rdev->desc->enable_val;
90 val = rdev->desc->enable_mask;
92 val = rdev->desc->disable_val;
95 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
96 rdev->desc->enable_mask, val);
98 EXPORT_SYMBOL_GPL(regulator_disable_regmap);
100 static int regulator_range_selector_to_index(struct regulator_dev *rdev,
105 if (!rdev->desc->linear_range_selectors)
108 rval &= rdev->desc->vsel_range_mask;
110 for (i = 0; i < rdev->desc->n_linear_ranges; i++) {
111 if (rdev->desc->linear_range_selectors[i] == rval)
118 * regulator_get_voltage_sel_pickable_regmap - pickable range get_voltage_sel
120 * @rdev: regulator to operate on
122 * Regulators that use regmap for their register I/O and use pickable
123 * ranges can set the vsel_reg, vsel_mask, vsel_range_reg and vsel_range_mask
124 * fields in their descriptor and then use this as their get_voltage_vsel
125 * operation, saving some code.
127 int regulator_get_voltage_sel_pickable_regmap(struct regulator_dev *rdev)
133 unsigned int voltages_in_range = 0;
135 if (!rdev->desc->linear_ranges)
138 ret = regmap_read(rdev->regmap, rdev->desc->vsel_reg, &val);
142 ret = regmap_read(rdev->regmap, rdev->desc->vsel_range_reg, &r_val);
146 val &= rdev->desc->vsel_mask;
147 val >>= ffs(rdev->desc->vsel_mask) - 1;
149 range = regulator_range_selector_to_index(rdev, r_val);
153 for (i = 0; i < range; i++)
154 voltages_in_range += (rdev->desc->linear_ranges[i].max_sel -
155 rdev->desc->linear_ranges[i].min_sel) + 1;
157 return val + voltages_in_range;
159 EXPORT_SYMBOL_GPL(regulator_get_voltage_sel_pickable_regmap);
162 * regulator_set_voltage_sel_pickable_regmap - pickable range set_voltage_sel
164 * @rdev: regulator to operate on
165 * @sel: Selector to set
167 * Regulators that use regmap for their register I/O and use pickable
168 * ranges can set the vsel_reg, vsel_mask, vsel_range_reg and vsel_range_mask
169 * fields in their descriptor and then use this as their set_voltage_vsel
170 * operation, saving some code.
172 int regulator_set_voltage_sel_pickable_regmap(struct regulator_dev *rdev,
177 unsigned int voltages_in_range = 0;
179 for (i = 0; i < rdev->desc->n_linear_ranges; i++) {
180 voltages_in_range = (rdev->desc->linear_ranges[i].max_sel -
181 rdev->desc->linear_ranges[i].min_sel) + 1;
182 if (sel < voltages_in_range)
184 sel -= voltages_in_range;
187 if (i == rdev->desc->n_linear_ranges)
190 sel <<= ffs(rdev->desc->vsel_mask) - 1;
191 sel += rdev->desc->linear_ranges[i].min_sel;
193 range = rdev->desc->linear_range_selectors[i];
195 if (rdev->desc->vsel_reg == rdev->desc->vsel_range_reg) {
196 ret = regmap_update_bits(rdev->regmap,
197 rdev->desc->vsel_reg,
198 rdev->desc->vsel_range_mask |
199 rdev->desc->vsel_mask, sel | range);
201 ret = regmap_update_bits(rdev->regmap,
202 rdev->desc->vsel_range_reg,
203 rdev->desc->vsel_range_mask, range);
207 ret = regmap_update_bits(rdev->regmap, rdev->desc->vsel_reg,
208 rdev->desc->vsel_mask, sel);
214 if (rdev->desc->apply_bit)
215 ret = regmap_update_bits(rdev->regmap, rdev->desc->apply_reg,
216 rdev->desc->apply_bit,
217 rdev->desc->apply_bit);
220 EXPORT_SYMBOL_GPL(regulator_set_voltage_sel_pickable_regmap);
223 * regulator_get_voltage_sel_regmap - standard get_voltage_sel for regmap users
225 * @rdev: regulator to operate on
227 * Regulators that use regmap for their register I/O can set the
228 * vsel_reg and vsel_mask fields in their descriptor and then use this
229 * as their get_voltage_vsel operation, saving some code.
231 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev)
236 ret = regmap_read(rdev->regmap, rdev->desc->vsel_reg, &val);
240 val &= rdev->desc->vsel_mask;
241 val >>= ffs(rdev->desc->vsel_mask) - 1;
245 EXPORT_SYMBOL_GPL(regulator_get_voltage_sel_regmap);
248 * regulator_set_voltage_sel_regmap - standard set_voltage_sel for regmap users
250 * @rdev: regulator to operate on
251 * @sel: Selector to set
253 * Regulators that use regmap for their register I/O can set the
254 * vsel_reg and vsel_mask fields in their descriptor and then use this
255 * as their set_voltage_vsel operation, saving some code.
257 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel)
261 sel <<= ffs(rdev->desc->vsel_mask) - 1;
263 ret = regmap_update_bits(rdev->regmap, rdev->desc->vsel_reg,
264 rdev->desc->vsel_mask, sel);
268 if (rdev->desc->apply_bit)
269 ret = regmap_update_bits(rdev->regmap, rdev->desc->apply_reg,
270 rdev->desc->apply_bit,
271 rdev->desc->apply_bit);
274 EXPORT_SYMBOL_GPL(regulator_set_voltage_sel_regmap);
277 * regulator_map_voltage_iterate - map_voltage() based on list_voltage()
279 * @rdev: Regulator to operate on
280 * @min_uV: Lower bound for voltage
281 * @max_uV: Upper bound for voltage
283 * Drivers implementing set_voltage_sel() and list_voltage() can use
284 * this as their map_voltage() operation. It will find a suitable
285 * voltage by calling list_voltage() until it gets something in bounds
286 * for the requested voltages.
288 int regulator_map_voltage_iterate(struct regulator_dev *rdev,
289 int min_uV, int max_uV)
291 int best_val = INT_MAX;
295 /* Find the smallest voltage that falls within the specified
298 for (i = 0; i < rdev->desc->n_voltages; i++) {
299 ret = rdev->desc->ops->list_voltage(rdev, i);
303 if (ret < best_val && ret >= min_uV && ret <= max_uV) {
309 if (best_val != INT_MAX)
314 EXPORT_SYMBOL_GPL(regulator_map_voltage_iterate);
317 * regulator_map_voltage_ascend - map_voltage() for ascendant voltage list
319 * @rdev: Regulator to operate on
320 * @min_uV: Lower bound for voltage
321 * @max_uV: Upper bound for voltage
323 * Drivers that have ascendant voltage list can use this as their
324 * map_voltage() operation.
326 int regulator_map_voltage_ascend(struct regulator_dev *rdev,
327 int min_uV, int max_uV)
331 for (i = 0; i < rdev->desc->n_voltages; i++) {
332 ret = rdev->desc->ops->list_voltage(rdev, i);
339 if (ret >= min_uV && ret <= max_uV)
345 EXPORT_SYMBOL_GPL(regulator_map_voltage_ascend);
348 * regulator_map_voltage_linear - map_voltage() for simple linear mappings
350 * @rdev: Regulator to operate on
351 * @min_uV: Lower bound for voltage
352 * @max_uV: Upper bound for voltage
354 * Drivers providing min_uV and uV_step in their regulator_desc can
355 * use this as their map_voltage() operation.
357 int regulator_map_voltage_linear(struct regulator_dev *rdev,
358 int min_uV, int max_uV)
362 /* Allow uV_step to be 0 for fixed voltage */
363 if (rdev->desc->n_voltages == 1 && rdev->desc->uV_step == 0) {
364 if (min_uV <= rdev->desc->min_uV && rdev->desc->min_uV <= max_uV)
370 if (!rdev->desc->uV_step) {
371 BUG_ON(!rdev->desc->uV_step);
375 if (min_uV < rdev->desc->min_uV)
376 min_uV = rdev->desc->min_uV;
378 ret = DIV_ROUND_UP(min_uV - rdev->desc->min_uV, rdev->desc->uV_step);
382 ret += rdev->desc->linear_min_sel;
384 /* Map back into a voltage to verify we're still in bounds */
385 voltage = rdev->desc->ops->list_voltage(rdev, ret);
386 if (voltage < min_uV || voltage > max_uV)
391 EXPORT_SYMBOL_GPL(regulator_map_voltage_linear);
394 * regulator_map_voltage_linear_range - map_voltage() for multiple linear ranges
396 * @rdev: Regulator to operate on
397 * @min_uV: Lower bound for voltage
398 * @max_uV: Upper bound for voltage
400 * Drivers providing linear_ranges in their descriptor can use this as
401 * their map_voltage() callback.
403 int regulator_map_voltage_linear_range(struct regulator_dev *rdev,
404 int min_uV, int max_uV)
406 const struct regulator_linear_range *range;
410 if (!rdev->desc->n_linear_ranges) {
411 BUG_ON(!rdev->desc->n_linear_ranges);
415 for (i = 0; i < rdev->desc->n_linear_ranges; i++) {
418 range = &rdev->desc->linear_ranges[i];
419 linear_max_uV = range->min_uV +
420 (range->max_sel - range->min_sel) * range->uV_step;
422 if (!(min_uV <= linear_max_uV && max_uV >= range->min_uV))
425 if (min_uV <= range->min_uV)
426 min_uV = range->min_uV;
428 /* range->uV_step == 0 means fixed voltage range */
429 if (range->uV_step == 0) {
432 ret = DIV_ROUND_UP(min_uV - range->min_uV,
438 ret += range->min_sel;
441 * Map back into a voltage to verify we're still in bounds.
442 * If we are not, then continue checking rest of the ranges.
444 voltage = rdev->desc->ops->list_voltage(rdev, ret);
445 if (voltage >= min_uV && voltage <= max_uV)
449 if (i == rdev->desc->n_linear_ranges)
454 EXPORT_SYMBOL_GPL(regulator_map_voltage_linear_range);
457 * regulator_map_voltage_pickable_linear_range - map_voltage, pickable ranges
459 * @rdev: Regulator to operate on
460 * @min_uV: Lower bound for voltage
461 * @max_uV: Upper bound for voltage
463 * Drivers providing pickable linear_ranges in their descriptor can use
464 * this as their map_voltage() callback.
466 int regulator_map_voltage_pickable_linear_range(struct regulator_dev *rdev,
467 int min_uV, int max_uV)
469 const struct regulator_linear_range *range;
472 unsigned int selector = 0;
474 if (!rdev->desc->n_linear_ranges) {
475 BUG_ON(!rdev->desc->n_linear_ranges);
479 for (i = 0; i < rdev->desc->n_linear_ranges; i++) {
482 range = &rdev->desc->linear_ranges[i];
483 linear_max_uV = range->min_uV +
484 (range->max_sel - range->min_sel) * range->uV_step;
486 if (!(min_uV <= linear_max_uV && max_uV >= range->min_uV)) {
487 selector += (range->max_sel - range->min_sel + 1);
491 if (min_uV <= range->min_uV)
492 min_uV = range->min_uV;
494 /* range->uV_step == 0 means fixed voltage range */
495 if (range->uV_step == 0) {
498 ret = DIV_ROUND_UP(min_uV - range->min_uV,
506 voltage = rdev->desc->ops->list_voltage(rdev, ret);
509 * Map back into a voltage to verify we're still in bounds.
510 * We may have overlapping voltage ranges. Hence we don't
511 * exit but retry until we have checked all ranges.
513 if (voltage < min_uV || voltage > max_uV)
514 selector += (range->max_sel - range->min_sel + 1);
519 if (i == rdev->desc->n_linear_ranges)
524 EXPORT_SYMBOL_GPL(regulator_map_voltage_pickable_linear_range);
527 * regulator_list_voltage_linear - List voltages with simple calculation
529 * @rdev: Regulator device
530 * @selector: Selector to convert into a voltage
532 * Regulators with a simple linear mapping between voltages and
533 * selectors can set min_uV and uV_step in the regulator descriptor
534 * and then use this function as their list_voltage() operation,
536 int regulator_list_voltage_linear(struct regulator_dev *rdev,
537 unsigned int selector)
539 if (selector >= rdev->desc->n_voltages)
541 if (selector < rdev->desc->linear_min_sel)
544 selector -= rdev->desc->linear_min_sel;
546 return rdev->desc->min_uV + (rdev->desc->uV_step * selector);
548 EXPORT_SYMBOL_GPL(regulator_list_voltage_linear);
551 * regulator_list_voltage_pickable_linear_range - pickable range list voltages
553 * @rdev: Regulator device
554 * @selector: Selector to convert into a voltage
556 * list_voltage() operation, intended to be used by drivers utilizing pickable
559 int regulator_list_voltage_pickable_linear_range(struct regulator_dev *rdev,
560 unsigned int selector)
562 const struct regulator_linear_range *range;
564 unsigned int all_sels = 0;
566 if (!rdev->desc->n_linear_ranges) {
567 BUG_ON(!rdev->desc->n_linear_ranges);
571 for (i = 0; i < rdev->desc->n_linear_ranges; i++) {
572 unsigned int sels_in_range;
574 range = &rdev->desc->linear_ranges[i];
576 sels_in_range = range->max_sel - range->min_sel;
578 if (all_sels + sels_in_range >= selector) {
579 selector -= all_sels;
580 return range->min_uV + (range->uV_step * selector);
583 all_sels += (sels_in_range + 1);
588 EXPORT_SYMBOL_GPL(regulator_list_voltage_pickable_linear_range);
591 * regulator_desc_list_voltage_linear_range - List voltages for linear ranges
593 * @desc: Regulator desc for regulator which volatges are to be listed
594 * @selector: Selector to convert into a voltage
596 * Regulators with a series of simple linear mappings between voltages
597 * and selectors who have set linear_ranges in the regulator descriptor
598 * can use this function prior regulator registration to list voltages.
599 * This is useful when voltages need to be listed during device-tree
602 int regulator_desc_list_voltage_linear_range(const struct regulator_desc *desc,
603 unsigned int selector)
605 const struct regulator_linear_range *range;
608 if (!desc->n_linear_ranges) {
609 BUG_ON(!desc->n_linear_ranges);
613 for (i = 0; i < desc->n_linear_ranges; i++) {
614 range = &desc->linear_ranges[i];
616 if (!(selector >= range->min_sel &&
617 selector <= range->max_sel))
620 selector -= range->min_sel;
622 return range->min_uV + (range->uV_step * selector);
627 EXPORT_SYMBOL_GPL(regulator_desc_list_voltage_linear_range);
630 * regulator_list_voltage_linear_range - List voltages for linear ranges
632 * @rdev: Regulator device
633 * @selector: Selector to convert into a voltage
635 * Regulators with a series of simple linear mappings between voltages
636 * and selectors can set linear_ranges in the regulator descriptor and
637 * then use this function as their list_voltage() operation,
639 int regulator_list_voltage_linear_range(struct regulator_dev *rdev,
640 unsigned int selector)
642 return regulator_desc_list_voltage_linear_range(rdev->desc, selector);
644 EXPORT_SYMBOL_GPL(regulator_list_voltage_linear_range);
647 * regulator_list_voltage_table - List voltages with table based mapping
649 * @rdev: Regulator device
650 * @selector: Selector to convert into a voltage
652 * Regulators with table based mapping between voltages and
653 * selectors can set volt_table in the regulator descriptor
654 * and then use this function as their list_voltage() operation.
656 int regulator_list_voltage_table(struct regulator_dev *rdev,
657 unsigned int selector)
659 if (!rdev->desc->volt_table) {
660 BUG_ON(!rdev->desc->volt_table);
664 if (selector >= rdev->desc->n_voltages)
667 return rdev->desc->volt_table[selector];
669 EXPORT_SYMBOL_GPL(regulator_list_voltage_table);
672 * regulator_set_bypass_regmap - Default set_bypass() using regmap
674 * @rdev: device to operate on.
675 * @enable: state to set.
677 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable)
682 val = rdev->desc->bypass_val_on;
684 val = rdev->desc->bypass_mask;
686 val = rdev->desc->bypass_val_off;
689 return regmap_update_bits(rdev->regmap, rdev->desc->bypass_reg,
690 rdev->desc->bypass_mask, val);
692 EXPORT_SYMBOL_GPL(regulator_set_bypass_regmap);
695 * regulator_set_soft_start_regmap - Default set_soft_start() using regmap
697 * @rdev: device to operate on.
699 int regulator_set_soft_start_regmap(struct regulator_dev *rdev)
703 val = rdev->desc->soft_start_val_on;
705 val = rdev->desc->soft_start_mask;
707 return regmap_update_bits(rdev->regmap, rdev->desc->soft_start_reg,
708 rdev->desc->soft_start_mask, val);
710 EXPORT_SYMBOL_GPL(regulator_set_soft_start_regmap);
713 * regulator_set_pull_down_regmap - Default set_pull_down() using regmap
715 * @rdev: device to operate on.
717 int regulator_set_pull_down_regmap(struct regulator_dev *rdev)
721 val = rdev->desc->pull_down_val_on;
723 val = rdev->desc->pull_down_mask;
725 return regmap_update_bits(rdev->regmap, rdev->desc->pull_down_reg,
726 rdev->desc->pull_down_mask, val);
728 EXPORT_SYMBOL_GPL(regulator_set_pull_down_regmap);
731 * regulator_get_bypass_regmap - Default get_bypass() using regmap
733 * @rdev: device to operate on.
734 * @enable: current state.
736 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable)
739 unsigned int val_on = rdev->desc->bypass_val_on;
742 ret = regmap_read(rdev->regmap, rdev->desc->bypass_reg, &val);
747 val_on = rdev->desc->bypass_mask;
749 *enable = (val & rdev->desc->bypass_mask) == val_on;
753 EXPORT_SYMBOL_GPL(regulator_get_bypass_regmap);
756 * regulator_set_active_discharge_regmap - Default set_active_discharge()
759 * @rdev: device to operate on.
760 * @enable: state to set, 0 to disable and 1 to enable.
762 int regulator_set_active_discharge_regmap(struct regulator_dev *rdev,
768 val = rdev->desc->active_discharge_on;
770 val = rdev->desc->active_discharge_off;
772 return regmap_update_bits(rdev->regmap,
773 rdev->desc->active_discharge_reg,
774 rdev->desc->active_discharge_mask, val);
776 EXPORT_SYMBOL_GPL(regulator_set_active_discharge_regmap);
779 * regulator_set_current_limit_regmap - set_current_limit for regmap users
781 * @rdev: regulator to operate on
782 * @min_uA: Lower bound for current limit
783 * @max_uA: Upper bound for current limit
785 * Regulators that use regmap for their register I/O can set curr_table,
786 * csel_reg and csel_mask fields in their descriptor and then use this
787 * as their set_current_limit operation, saving some code.
789 int regulator_set_current_limit_regmap(struct regulator_dev *rdev,
790 int min_uA, int max_uA)
792 unsigned int n_currents = rdev->desc->n_current_limits;
798 if (rdev->desc->curr_table) {
799 const unsigned int *curr_table = rdev->desc->curr_table;
800 bool ascend = curr_table[n_currents - 1] > curr_table[0];
802 /* search for closest to maximum */
804 for (i = n_currents - 1; i >= 0; i--) {
805 if (min_uA <= curr_table[i] &&
806 curr_table[i] <= max_uA) {
812 for (i = 0; i < n_currents; i++) {
813 if (min_uA <= curr_table[i] &&
814 curr_table[i] <= max_uA) {
825 sel <<= ffs(rdev->desc->csel_mask) - 1;
827 return regmap_update_bits(rdev->regmap, rdev->desc->csel_reg,
828 rdev->desc->csel_mask, sel);
830 EXPORT_SYMBOL_GPL(regulator_set_current_limit_regmap);
833 * regulator_get_current_limit_regmap - get_current_limit for regmap users
835 * @rdev: regulator to operate on
837 * Regulators that use regmap for their register I/O can set the
838 * csel_reg and csel_mask fields in their descriptor and then use this
839 * as their get_current_limit operation, saving some code.
841 int regulator_get_current_limit_regmap(struct regulator_dev *rdev)
846 ret = regmap_read(rdev->regmap, rdev->desc->csel_reg, &val);
850 val &= rdev->desc->csel_mask;
851 val >>= ffs(rdev->desc->csel_mask) - 1;
853 if (rdev->desc->curr_table) {
854 if (val >= rdev->desc->n_current_limits)
857 return rdev->desc->curr_table[val];
862 EXPORT_SYMBOL_GPL(regulator_get_current_limit_regmap);
865 * regulator_bulk_set_supply_names - initialize the 'supply' fields in an array
866 * of regulator_bulk_data structs
868 * @consumers: array of regulator_bulk_data entries to initialize
869 * @supply_names: array of supply name strings
870 * @num_supplies: number of supply names to initialize
872 * Note: the 'consumers' array must be the size of 'num_supplies'.
874 void regulator_bulk_set_supply_names(struct regulator_bulk_data *consumers,
875 const char *const *supply_names,
876 unsigned int num_supplies)
880 for (i = 0; i < num_supplies; i++)
881 consumers[i].supply = supply_names[i];
883 EXPORT_SYMBOL_GPL(regulator_bulk_set_supply_names);