linux/drivers/regulator/bcm590xx-regulator.c
Douglas Anderson 259b93b21a
regulator: Set PROBE_PREFER_ASYNCHRONOUS for drivers that existed in 4.14
Probing of regulators can be a slow operation and can contribute to
slower boot times. This is especially true if a regulator is turned on
at probe time (with regulator-boot-on or regulator-always-on) and the
regulator requires delays (off-on-time, ramp time, etc).

While the overall kernel is not ready to switch to async probe by
default, as per the discussion on the mailing lists [1] it is believed
that the regulator subsystem is in good shape and we can move
regulator drivers over wholesale. There is no way to just magically
opt in all regulators (regulators are just normal drivers like
platform_driver), so we set PROBE_PREFER_ASYNCHRONOUS for all
regulators found in 'drivers/regulator' individually.

Given the number of drivers touched and the impossibility to test this
ahead of time, it wouldn't be shocking at all if this caused a
regression for someone. If there is a regression caused by this patch,
it's likely to be one of the cases talked about in [1]. As a "quick
fix", drivers involved in the regression could be fixed by changing
them to PROBE_FORCE_SYNCHRONOUS. That being said, the correct fix
would be to directly fix the problem that caused the issue with async
probe.

The approach here follows a similar approach that was used for the mmc
subsystem several years ago [2]. In fact, I ran nearly the same python
script to auto-generate the changes. The only thing I changed was to
search for "i2c_driver", "spmi_driver", and "spi_driver" in addition
to "platform_driver".

[1] https://lore.kernel.org/r/06db017f-e985-4434-8d1d-02ca2100cca0@sirena.org.uk
[2] https://lore.kernel.org/r/20200903232441.2694866-1-dianders@chromium.org/

Signed-off-by: Douglas Anderson <dianders@chromium.org>
Link: https://lore.kernel.org/r/20230316125351.1.I2a4677392a38db5758dee0788b2cea5872562a82@changeid
Signed-off-by: Mark Brown <broonie@kernel.org>
2023-03-20 13:11:25 +00:00

367 lines
10 KiB
C

// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Broadcom BCM590xx regulator driver
*
* Copyright 2014 Linaro Limited
* Author: Matt Porter <mporter@linaro.org>
*/
#include <linux/err.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/mfd/bcm590xx.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/regulator/driver.h>
#include <linux/regulator/machine.h>
#include <linux/regulator/of_regulator.h>
#include <linux/slab.h>
/* I2C slave 0 registers */
#define BCM590XX_RFLDOPMCTRL1 0x60
#define BCM590XX_IOSR1PMCTRL1 0x7a
#define BCM590XX_IOSR2PMCTRL1 0x7c
#define BCM590XX_CSRPMCTRL1 0x7e
#define BCM590XX_SDSR1PMCTRL1 0x82
#define BCM590XX_SDSR2PMCTRL1 0x86
#define BCM590XX_MSRPMCTRL1 0x8a
#define BCM590XX_VSRPMCTRL1 0x8e
#define BCM590XX_RFLDOCTRL 0x96
#define BCM590XX_CSRVOUT1 0xc0
/* I2C slave 1 registers */
#define BCM590XX_GPLDO5PMCTRL1 0x16
#define BCM590XX_GPLDO6PMCTRL1 0x18
#define BCM590XX_GPLDO1CTRL 0x1a
#define BCM590XX_GPLDO2CTRL 0x1b
#define BCM590XX_GPLDO3CTRL 0x1c
#define BCM590XX_GPLDO4CTRL 0x1d
#define BCM590XX_GPLDO5CTRL 0x1e
#define BCM590XX_GPLDO6CTRL 0x1f
#define BCM590XX_OTG_CTRL 0x40
#define BCM590XX_GPLDO1PMCTRL1 0x57
#define BCM590XX_GPLDO2PMCTRL1 0x59
#define BCM590XX_GPLDO3PMCTRL1 0x5b
#define BCM590XX_GPLDO4PMCTRL1 0x5d
#define BCM590XX_REG_ENABLE BIT(7)
#define BCM590XX_VBUS_ENABLE BIT(2)
#define BCM590XX_LDO_VSEL_MASK GENMASK(5, 3)
#define BCM590XX_SR_VSEL_MASK GENMASK(5, 0)
/*
* RFLDO to VSR regulators are
* accessed via I2C slave 0
*/
/* LDO regulator IDs */
#define BCM590XX_REG_RFLDO 0
#define BCM590XX_REG_CAMLDO1 1
#define BCM590XX_REG_CAMLDO2 2
#define BCM590XX_REG_SIMLDO1 3
#define BCM590XX_REG_SIMLDO2 4
#define BCM590XX_REG_SDLDO 5
#define BCM590XX_REG_SDXLDO 6
#define BCM590XX_REG_MMCLDO1 7
#define BCM590XX_REG_MMCLDO2 8
#define BCM590XX_REG_AUDLDO 9
#define BCM590XX_REG_MICLDO 10
#define BCM590XX_REG_USBLDO 11
#define BCM590XX_REG_VIBLDO 12
/* DCDC regulator IDs */
#define BCM590XX_REG_CSR 13
#define BCM590XX_REG_IOSR1 14
#define BCM590XX_REG_IOSR2 15
#define BCM590XX_REG_MSR 16
#define BCM590XX_REG_SDSR1 17
#define BCM590XX_REG_SDSR2 18
#define BCM590XX_REG_VSR 19
/*
* GPLDO1 to VBUS regulators are
* accessed via I2C slave 1
*/
#define BCM590XX_REG_GPLDO1 20
#define BCM590XX_REG_GPLDO2 21
#define BCM590XX_REG_GPLDO3 22
#define BCM590XX_REG_GPLDO4 23
#define BCM590XX_REG_GPLDO5 24
#define BCM590XX_REG_GPLDO6 25
#define BCM590XX_REG_VBUS 26
#define BCM590XX_NUM_REGS 27
#define BCM590XX_REG_IS_LDO(n) (n < BCM590XX_REG_CSR)
#define BCM590XX_REG_IS_GPLDO(n) \
((n > BCM590XX_REG_VSR) && (n < BCM590XX_REG_VBUS))
#define BCM590XX_REG_IS_VBUS(n) (n == BCM590XX_REG_VBUS)
/* LDO group A: supported voltages in microvolts */
static const unsigned int ldo_a_table[] = {
1200000, 1800000, 2500000, 2700000, 2800000,
2900000, 3000000, 3300000,
};
/* LDO group C: supported voltages in microvolts */
static const unsigned int ldo_c_table[] = {
3100000, 1800000, 2500000, 2700000, 2800000,
2900000, 3000000, 3300000,
};
static const unsigned int ldo_vbus[] = {
5000000,
};
/* DCDC group CSR: supported voltages in microvolts */
static const struct linear_range dcdc_csr_ranges[] = {
REGULATOR_LINEAR_RANGE(860000, 2, 50, 10000),
REGULATOR_LINEAR_RANGE(1360000, 51, 55, 20000),
REGULATOR_LINEAR_RANGE(900000, 56, 63, 0),
};
/* DCDC group IOSR1: supported voltages in microvolts */
static const struct linear_range dcdc_iosr1_ranges[] = {
REGULATOR_LINEAR_RANGE(860000, 2, 51, 10000),
REGULATOR_LINEAR_RANGE(1500000, 52, 52, 0),
REGULATOR_LINEAR_RANGE(1800000, 53, 53, 0),
REGULATOR_LINEAR_RANGE(900000, 54, 63, 0),
};
/* DCDC group SDSR1: supported voltages in microvolts */
static const struct linear_range dcdc_sdsr1_ranges[] = {
REGULATOR_LINEAR_RANGE(860000, 2, 50, 10000),
REGULATOR_LINEAR_RANGE(1340000, 51, 51, 0),
REGULATOR_LINEAR_RANGE(900000, 52, 63, 0),
};
struct bcm590xx_info {
const char *name;
const char *vin_name;
u8 n_voltages;
const unsigned int *volt_table;
u8 n_linear_ranges;
const struct linear_range *linear_ranges;
};
#define BCM590XX_REG_TABLE(_name, _table) \
{ \
.name = #_name, \
.n_voltages = ARRAY_SIZE(_table), \
.volt_table = _table, \
}
#define BCM590XX_REG_RANGES(_name, _ranges) \
{ \
.name = #_name, \
.n_voltages = 64, \
.n_linear_ranges = ARRAY_SIZE(_ranges), \
.linear_ranges = _ranges, \
}
static struct bcm590xx_info bcm590xx_regs[] = {
BCM590XX_REG_TABLE(rfldo, ldo_a_table),
BCM590XX_REG_TABLE(camldo1, ldo_c_table),
BCM590XX_REG_TABLE(camldo2, ldo_c_table),
BCM590XX_REG_TABLE(simldo1, ldo_a_table),
BCM590XX_REG_TABLE(simldo2, ldo_a_table),
BCM590XX_REG_TABLE(sdldo, ldo_c_table),
BCM590XX_REG_TABLE(sdxldo, ldo_a_table),
BCM590XX_REG_TABLE(mmcldo1, ldo_a_table),
BCM590XX_REG_TABLE(mmcldo2, ldo_a_table),
BCM590XX_REG_TABLE(audldo, ldo_a_table),
BCM590XX_REG_TABLE(micldo, ldo_a_table),
BCM590XX_REG_TABLE(usbldo, ldo_a_table),
BCM590XX_REG_TABLE(vibldo, ldo_c_table),
BCM590XX_REG_RANGES(csr, dcdc_csr_ranges),
BCM590XX_REG_RANGES(iosr1, dcdc_iosr1_ranges),
BCM590XX_REG_RANGES(iosr2, dcdc_iosr1_ranges),
BCM590XX_REG_RANGES(msr, dcdc_iosr1_ranges),
BCM590XX_REG_RANGES(sdsr1, dcdc_sdsr1_ranges),
BCM590XX_REG_RANGES(sdsr2, dcdc_iosr1_ranges),
BCM590XX_REG_RANGES(vsr, dcdc_iosr1_ranges),
BCM590XX_REG_TABLE(gpldo1, ldo_a_table),
BCM590XX_REG_TABLE(gpldo2, ldo_a_table),
BCM590XX_REG_TABLE(gpldo3, ldo_a_table),
BCM590XX_REG_TABLE(gpldo4, ldo_a_table),
BCM590XX_REG_TABLE(gpldo5, ldo_a_table),
BCM590XX_REG_TABLE(gpldo6, ldo_a_table),
BCM590XX_REG_TABLE(vbus, ldo_vbus),
};
struct bcm590xx_reg {
struct regulator_desc *desc;
struct bcm590xx *mfd;
};
static int bcm590xx_get_vsel_register(int id)
{
if (BCM590XX_REG_IS_LDO(id))
return BCM590XX_RFLDOCTRL + id;
else if (BCM590XX_REG_IS_GPLDO(id))
return BCM590XX_GPLDO1CTRL + id;
else
return BCM590XX_CSRVOUT1 + (id - BCM590XX_REG_CSR) * 3;
}
static int bcm590xx_get_enable_register(int id)
{
int reg = 0;
if (BCM590XX_REG_IS_LDO(id))
reg = BCM590XX_RFLDOPMCTRL1 + id * 2;
else if (BCM590XX_REG_IS_GPLDO(id))
reg = BCM590XX_GPLDO1PMCTRL1 + id * 2;
else
switch (id) {
case BCM590XX_REG_CSR:
reg = BCM590XX_CSRPMCTRL1;
break;
case BCM590XX_REG_IOSR1:
reg = BCM590XX_IOSR1PMCTRL1;
break;
case BCM590XX_REG_IOSR2:
reg = BCM590XX_IOSR2PMCTRL1;
break;
case BCM590XX_REG_MSR:
reg = BCM590XX_MSRPMCTRL1;
break;
case BCM590XX_REG_SDSR1:
reg = BCM590XX_SDSR1PMCTRL1;
break;
case BCM590XX_REG_SDSR2:
reg = BCM590XX_SDSR2PMCTRL1;
break;
case BCM590XX_REG_VSR:
reg = BCM590XX_VSRPMCTRL1;
break;
case BCM590XX_REG_VBUS:
reg = BCM590XX_OTG_CTRL;
break;
}
return reg;
}
static const struct regulator_ops bcm590xx_ops_ldo = {
.is_enabled = regulator_is_enabled_regmap,
.enable = regulator_enable_regmap,
.disable = regulator_disable_regmap,
.get_voltage_sel = regulator_get_voltage_sel_regmap,
.set_voltage_sel = regulator_set_voltage_sel_regmap,
.list_voltage = regulator_list_voltage_table,
.map_voltage = regulator_map_voltage_iterate,
};
static const struct regulator_ops bcm590xx_ops_dcdc = {
.is_enabled = regulator_is_enabled_regmap,
.enable = regulator_enable_regmap,
.disable = regulator_disable_regmap,
.get_voltage_sel = regulator_get_voltage_sel_regmap,
.set_voltage_sel = regulator_set_voltage_sel_regmap,
.list_voltage = regulator_list_voltage_linear_range,
.map_voltage = regulator_map_voltage_linear_range,
};
static const struct regulator_ops bcm590xx_ops_vbus = {
.is_enabled = regulator_is_enabled_regmap,
.enable = regulator_enable_regmap,
.disable = regulator_disable_regmap,
};
static int bcm590xx_probe(struct platform_device *pdev)
{
struct bcm590xx *bcm590xx = dev_get_drvdata(pdev->dev.parent);
struct bcm590xx_reg *pmu;
struct regulator_config config = { };
struct bcm590xx_info *info;
struct regulator_dev *rdev;
int i;
pmu = devm_kzalloc(&pdev->dev, sizeof(*pmu), GFP_KERNEL);
if (!pmu)
return -ENOMEM;
pmu->mfd = bcm590xx;
platform_set_drvdata(pdev, pmu);
pmu->desc = devm_kcalloc(&pdev->dev,
BCM590XX_NUM_REGS,
sizeof(struct regulator_desc),
GFP_KERNEL);
if (!pmu->desc)
return -ENOMEM;
info = bcm590xx_regs;
for (i = 0; i < BCM590XX_NUM_REGS; i++, info++) {
/* Register the regulators */
pmu->desc[i].name = info->name;
pmu->desc[i].of_match = of_match_ptr(info->name);
pmu->desc[i].regulators_node = of_match_ptr("regulators");
pmu->desc[i].supply_name = info->vin_name;
pmu->desc[i].id = i;
pmu->desc[i].volt_table = info->volt_table;
pmu->desc[i].n_voltages = info->n_voltages;
pmu->desc[i].linear_ranges = info->linear_ranges;
pmu->desc[i].n_linear_ranges = info->n_linear_ranges;
if ((BCM590XX_REG_IS_LDO(i)) || (BCM590XX_REG_IS_GPLDO(i))) {
pmu->desc[i].ops = &bcm590xx_ops_ldo;
pmu->desc[i].vsel_mask = BCM590XX_LDO_VSEL_MASK;
} else if (BCM590XX_REG_IS_VBUS(i))
pmu->desc[i].ops = &bcm590xx_ops_vbus;
else {
pmu->desc[i].ops = &bcm590xx_ops_dcdc;
pmu->desc[i].vsel_mask = BCM590XX_SR_VSEL_MASK;
}
if (BCM590XX_REG_IS_VBUS(i))
pmu->desc[i].enable_mask = BCM590XX_VBUS_ENABLE;
else {
pmu->desc[i].vsel_reg = bcm590xx_get_vsel_register(i);
pmu->desc[i].enable_is_inverted = true;
pmu->desc[i].enable_mask = BCM590XX_REG_ENABLE;
}
pmu->desc[i].enable_reg = bcm590xx_get_enable_register(i);
pmu->desc[i].type = REGULATOR_VOLTAGE;
pmu->desc[i].owner = THIS_MODULE;
config.dev = bcm590xx->dev;
config.driver_data = pmu;
if (BCM590XX_REG_IS_GPLDO(i) || BCM590XX_REG_IS_VBUS(i))
config.regmap = bcm590xx->regmap_sec;
else
config.regmap = bcm590xx->regmap_pri;
rdev = devm_regulator_register(&pdev->dev, &pmu->desc[i],
&config);
if (IS_ERR(rdev)) {
dev_err(bcm590xx->dev,
"failed to register %s regulator\n",
pdev->name);
return PTR_ERR(rdev);
}
}
return 0;
}
static struct platform_driver bcm590xx_regulator_driver = {
.driver = {
.name = "bcm590xx-vregs",
.probe_type = PROBE_PREFER_ASYNCHRONOUS,
},
.probe = bcm590xx_probe,
};
module_platform_driver(bcm590xx_regulator_driver);
MODULE_AUTHOR("Matt Porter <mporter@linaro.org>");
MODULE_DESCRIPTION("BCM590xx voltage regulator driver");
MODULE_LICENSE("GPL v2");
MODULE_ALIAS("platform:bcm590xx-vregs");