[mirror_ubuntu-hirsute-kernel.git] / drivers / regulator / mcp16502.c

// SPDX-License-Identifier: GPL-2.0
//
// MCP16502 PMIC driver
//
// Copyright (C) 2018 Microchip Technology Inc. and its subsidiaries
//
// Author: Andrei Stefanescu <andrei.stefanescu@microchip.com>
//
// Inspired from tps65086-regulator.c

#include <linux/gpio.h>
#include <linux/i2c.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/regmap.h>
#include <linux/regulator/driver.h>
#include <linux/suspend.h>
#include <linux/gpio/consumer.h>

#define VDD_LOW_SEL 0x0D
#define VDD_HIGH_SEL 0x3F

#define MCP16502_FLT		BIT(7)
#define MCP16502_DVSR		GENMASK(3, 2)
#define MCP16502_ENS		BIT(0)

/*
 * The PMIC has four sets of registers corresponding to four power modes:
 * Performance, Active, Low-power, Hibernate.
 *
 * Registers:
 * Each regulator has a register for each power mode. To access a register
 * for a specific regulator and mode BASE_* and OFFSET_* need to be added.
 *
 * Operating modes:
 * In order for the PMIC to transition to operating modes it has to be
 * controlled via GPIO lines called LPM and HPM.
 *
 * The registers are fully configurable such that you can put all regulators in
 * a low-power state while the PMIC is in Active mode. They are supposed to be
 * configured at startup and then simply transition to/from a global low-power
 * state by setting the GPIO lpm pin high/low.
 *
 * This driver keeps the PMIC in Active mode, Low-power state is set for the
 * regulators by enabling/disabling operating mode (FPWM or Auto PFM).
 *
 * The PMIC's Low-power and Hibernate modes are used during standby/suspend.
 * To enter standby/suspend the PMIC will go to Low-power mode. From there, it
 * will transition to Hibernate when the PWRHLD line is set to low by the MPU.
 */

/*
 * This function is useful for iterating over all regulators and accessing their
 * registers in a generic way or accessing a regulator device by its id.
 */
#define MCP16502_REG_BASE(i, r) ((((i) + 1) << 4) + MCP16502_REG_##r)
#define MCP16502_STAT_BASE(i) ((i) + 5)

#define MCP16502_OPMODE_ACTIVE REGULATOR_MODE_NORMAL
#define MCP16502_OPMODE_LPM REGULATOR_MODE_IDLE
#define MCP16502_OPMODE_HIB REGULATOR_MODE_STANDBY

#define MCP16502_MODE_AUTO_PFM 0
#define MCP16502_MODE_FPWM BIT(6)

#define MCP16502_VSEL 0x3F
#define MCP16502_EN BIT(7)
#define MCP16502_MODE BIT(6)

#define MCP16502_MIN_REG 0x0
#define MCP16502_MAX_REG 0x65

/**
 * enum mcp16502_reg - MCP16502 regulators's registers
 * @MCP16502_REG_A: active state register
 * @MCP16502_REG_LPM: low power mode state register
 * @MCP16502_REG_HIB: hibernate state register
 * @MCP16502_REG_SEQ: startup sequence register
 * @MCP16502_REG_CFG: configuration register
 */
enum mcp16502_reg {
	MCP16502_REG_A,
	MCP16502_REG_LPM,
	MCP16502_REG_HIB,
	MCP16502_REG_HPM,
	MCP16502_REG_SEQ,
	MCP16502_REG_CFG,
};

/* Ramp delay (uV/us) for buck1, ldo1, ldo2. */
static const int mcp16502_ramp_b1l12[] = { 6250, 3125, 2083, 1563 };

/* Ramp delay (uV/us) for buck2, buck3, buck4. */
static const int mcp16502_ramp_b234[] = { 3125, 1563, 1042, 781 };

static unsigned int mcp16502_of_map_mode(unsigned int mode)
{
	if (mode == REGULATOR_MODE_NORMAL || mode == REGULATOR_MODE_IDLE)
		return mode;

	return REGULATOR_MODE_INVALID;
}

#define MCP16502_REGULATOR(_name, _id, _ranges, _ops)			\
	[_id] = {							\
		.name			= _name,			\
		.regulators_node	= of_match_ptr("regulators"),	\
		.id			= _id,				\
		.ops			= &(_ops),			\
		.type			= REGULATOR_VOLTAGE,		\
		.owner			= THIS_MODULE,			\
		.n_voltages		= MCP16502_VSEL + 1,		\
		.linear_ranges		= _ranges,			\
		.linear_min_sel		= VDD_LOW_SEL,			\
		.n_linear_ranges	= ARRAY_SIZE(_ranges),		\
		.of_match		= of_match_ptr(_name),		\
		.of_map_mode		= mcp16502_of_map_mode,		\
		.vsel_reg		= (((_id) + 1) << 4),		\
		.vsel_mask		= MCP16502_VSEL,		\
		.enable_reg		= (((_id) + 1) << 4),		\
		.enable_mask		= MCP16502_EN,			\
	}

enum {
	BUCK1 = 0,
	BUCK2,
	BUCK3,
	BUCK4,
	LDO1,
	LDO2,
	NUM_REGULATORS
};

/*
 * struct mcp16502 - PMIC representation
 * @lpm: LPM GPIO descriptor
 */
struct mcp16502 {
	struct gpio_desc *lpm;
};

/*
 * mcp16502_gpio_set_mode() - set the GPIO corresponding value
 *
 * Used to prepare transitioning into hibernate or resuming from it.
 */
static void mcp16502_gpio_set_mode(struct mcp16502 *mcp, int mode)
{
	switch (mode) {
	case MCP16502_OPMODE_ACTIVE:
		gpiod_set_value(mcp->lpm, 0);
		break;
	case MCP16502_OPMODE_LPM:
	case MCP16502_OPMODE_HIB:
		gpiod_set_value(mcp->lpm, 1);
		break;
	default:
		pr_err("%s: %d invalid\n", __func__, mode);
	}
}

/*
 * mcp16502_get_reg() - get the PMIC's state configuration register for opmode
 *
 * @rdev: the regulator whose register we are searching
 * @opmode: the PMIC's operating mode ACTIVE, Low-power, Hibernate
 */
static int mcp16502_get_state_reg(struct regulator_dev *rdev, int opmode)
{
	switch (opmode) {
	case MCP16502_OPMODE_ACTIVE:
		return MCP16502_REG_BASE(rdev_get_id(rdev), A);
	case MCP16502_OPMODE_LPM:
		return MCP16502_REG_BASE(rdev_get_id(rdev), LPM);
	case MCP16502_OPMODE_HIB:
		return MCP16502_REG_BASE(rdev_get_id(rdev), HIB);
	default:
		return -EINVAL;
	}
}

/*
 * mcp16502_get_mode() - return the current operating mode of a regulator
 *
 * Note: all functions that are not part of entering/exiting standby/suspend
 *	 use the Active mode registers.
 *
 * Note: this is different from the PMIC's operatig mode, it is the
 *	 MODE bit from the regulator's register.
 */
static unsigned int mcp16502_get_mode(struct regulator_dev *rdev)
{
	unsigned int val;
	int ret, reg;

	reg = mcp16502_get_state_reg(rdev, MCP16502_OPMODE_ACTIVE);
	if (reg < 0)
		return reg;

	ret = regmap_read(rdev->regmap, reg, &val);
	if (ret)
		return ret;

	switch (val & MCP16502_MODE) {
	case MCP16502_MODE_FPWM:
		return REGULATOR_MODE_NORMAL;
	case MCP16502_MODE_AUTO_PFM:
		return REGULATOR_MODE_IDLE;
	default:
		return REGULATOR_MODE_INVALID;
	}
}

/*
 * _mcp16502_set_mode() - helper for set_mode and set_suspend_mode
 *
 * @rdev: the regulator for which we are setting the mode
 * @mode: the regulator's mode (the one from MODE bit)
 * @opmode: the PMIC's operating mode: Active/Low-power/Hibernate
 */
static int _mcp16502_set_mode(struct regulator_dev *rdev, unsigned int mode,
			      unsigned int op_mode)
{
	int val;
	int reg;

	reg = mcp16502_get_state_reg(rdev, op_mode);
	if (reg < 0)
		return reg;

	switch (mode) {
	case REGULATOR_MODE_NORMAL:
		val = MCP16502_MODE_FPWM;
		break;
	case REGULATOR_MODE_IDLE:
		val = MCP16502_MODE_AUTO_PFM;
		break;
	default:
		return -EINVAL;
	}

	reg = regmap_update_bits(rdev->regmap, reg, MCP16502_MODE, val);
	return reg;
}

/*
 * mcp16502_set_mode() - regulator_ops set_mode
 */
static int mcp16502_set_mode(struct regulator_dev *rdev, unsigned int mode)
{
	return _mcp16502_set_mode(rdev, mode, MCP16502_OPMODE_ACTIVE);
}

/*
 * mcp16502_get_status() - regulator_ops get_status
 */
static int mcp16502_get_status(struct regulator_dev *rdev)
{
	int ret;
	unsigned int val;

	ret = regmap_read(rdev->regmap, MCP16502_STAT_BASE(rdev_get_id(rdev)),
			  &val);
	if (ret)
		return ret;

	if (val & MCP16502_FLT)
		return REGULATOR_STATUS_ERROR;
	else if (val & MCP16502_ENS)
		return REGULATOR_STATUS_ON;
	else if (!(val & MCP16502_ENS))
		return REGULATOR_STATUS_OFF;

	return REGULATOR_STATUS_UNDEFINED;
}

static int mcp16502_set_voltage_time_sel(struct regulator_dev *rdev,
					 unsigned int old_sel,
					 unsigned int new_sel)
{
	static const u8 us_ramp[] = { 8, 16, 24, 32 };
	int id = rdev_get_id(rdev);
	unsigned int uV_delta, val;
	int ret;

	ret = regmap_read(rdev->regmap, MCP16502_REG_BASE(id, CFG), &val);
	if (ret)
		return ret;

	val = (val & MCP16502_DVSR) >> 2;
	uV_delta = abs(new_sel * rdev->desc->linear_ranges->step -
		       old_sel * rdev->desc->linear_ranges->step);
	switch (id) {
	case BUCK1:
	case LDO1:
	case LDO2:
		ret = DIV_ROUND_CLOSEST(uV_delta * us_ramp[val],
					mcp16502_ramp_b1l12[val]);
		break;

	case BUCK2:
	case BUCK3:
	case BUCK4:
		ret = DIV_ROUND_CLOSEST(uV_delta * us_ramp[val],
					mcp16502_ramp_b234[val]);
		break;

	default:
		return -EINVAL;
	}

	return ret;
}

static int mcp16502_set_ramp_delay(struct regulator_dev *rdev, int ramp_delay)
{
	const int *ramp;
	int id = rdev_get_id(rdev);
	unsigned int i, size;

	switch (id) {
	case BUCK1:
	case LDO1:
	case LDO2:
		ramp = mcp16502_ramp_b1l12;
		size = ARRAY_SIZE(mcp16502_ramp_b1l12);
		break;

	case BUCK2:
	case BUCK3:
	case BUCK4:
		ramp = mcp16502_ramp_b234;
		size = ARRAY_SIZE(mcp16502_ramp_b234);
		break;

	default:
		return -EINVAL;
	}

	for (i = 0; i < size; i++) {
		if (ramp[i] == ramp_delay)
			break;
	}
	if (i == size)
		return -EINVAL;

	return regmap_update_bits(rdev->regmap, MCP16502_REG_BASE(id, CFG),
				  MCP16502_DVSR, (i << 2));
}

#ifdef CONFIG_SUSPEND
/*
 * mcp16502_suspend_get_target_reg() - get the reg of the target suspend PMIC
 *				       mode
 */
static int mcp16502_suspend_get_target_reg(struct regulator_dev *rdev)
{
	switch (pm_suspend_target_state) {
	case PM_SUSPEND_STANDBY:
		return mcp16502_get_state_reg(rdev, MCP16502_OPMODE_LPM);
	case PM_SUSPEND_ON:
	case PM_SUSPEND_MEM:
		return mcp16502_get_state_reg(rdev, MCP16502_OPMODE_HIB);
	default:
		dev_err(&rdev->dev, "invalid suspend target: %d\n",
			pm_suspend_target_state);
	}

	return -EINVAL;
}

/*
 * mcp16502_set_suspend_voltage() - regulator_ops set_suspend_voltage
 */
static int mcp16502_set_suspend_voltage(struct regulator_dev *rdev, int uV)
{
	int sel = regulator_map_voltage_linear_range(rdev, uV, uV);
	int reg = mcp16502_suspend_get_target_reg(rdev);

	if (sel < 0)
		return sel;

	if (reg < 0)
		return reg;

	return regmap_update_bits(rdev->regmap, reg, MCP16502_VSEL, sel);
}

/*
 * mcp16502_set_suspend_mode() - regulator_ops set_suspend_mode
 */
static int mcp16502_set_suspend_mode(struct regulator_dev *rdev,
				     unsigned int mode)
{
	switch (pm_suspend_target_state) {
	case PM_SUSPEND_STANDBY:
		return _mcp16502_set_mode(rdev, mode, MCP16502_OPMODE_LPM);
	case PM_SUSPEND_ON:
	case PM_SUSPEND_MEM:
		return _mcp16502_set_mode(rdev, mode, MCP16502_OPMODE_HIB);
	default:
		dev_err(&rdev->dev, "invalid suspend target: %d\n",
			pm_suspend_target_state);
	}

	return -EINVAL;
}

/*
 * mcp16502_set_suspend_enable() - regulator_ops set_suspend_enable
 */
static int mcp16502_set_suspend_enable(struct regulator_dev *rdev)
{
	int reg = mcp16502_suspend_get_target_reg(rdev);

	if (reg < 0)
		return reg;

	return regmap_update_bits(rdev->regmap, reg, MCP16502_EN, MCP16502_EN);
}

/*
 * mcp16502_set_suspend_disable() - regulator_ops set_suspend_disable
 */
static int mcp16502_set_suspend_disable(struct regulator_dev *rdev)
{
	int reg = mcp16502_suspend_get_target_reg(rdev);

	if (reg < 0)
		return reg;

	return regmap_update_bits(rdev->regmap, reg, MCP16502_EN, 0);
}
#endif /* CONFIG_SUSPEND */

static const struct regulator_ops mcp16502_buck_ops = {
	.list_voltage			= regulator_list_voltage_linear_range,
	.map_voltage			= regulator_map_voltage_linear_range,
	.get_voltage_sel		= regulator_get_voltage_sel_regmap,
	.set_voltage_sel		= regulator_set_voltage_sel_regmap,
	.enable				= regulator_enable_regmap,
	.disable			= regulator_disable_regmap,
	.is_enabled			= regulator_is_enabled_regmap,
	.get_status			= mcp16502_get_status,
	.set_voltage_time_sel		= mcp16502_set_voltage_time_sel,
	.set_ramp_delay			= mcp16502_set_ramp_delay,

	.set_mode			= mcp16502_set_mode,
	.get_mode			= mcp16502_get_mode,

#ifdef CONFIG_SUSPEND
	.set_suspend_voltage		= mcp16502_set_suspend_voltage,
	.set_suspend_mode		= mcp16502_set_suspend_mode,
	.set_suspend_enable		= mcp16502_set_suspend_enable,
	.set_suspend_disable		= mcp16502_set_suspend_disable,
#endif /* CONFIG_SUSPEND */
};

/*
 * LDOs cannot change operating modes.
 */
static const struct regulator_ops mcp16502_ldo_ops = {
	.list_voltage			= regulator_list_voltage_linear_range,
	.map_voltage			= regulator_map_voltage_linear_range,
	.get_voltage_sel		= regulator_get_voltage_sel_regmap,
	.set_voltage_sel		= regulator_set_voltage_sel_regmap,
	.enable				= regulator_enable_regmap,
	.disable			= regulator_disable_regmap,
	.is_enabled			= regulator_is_enabled_regmap,
	.get_status			= mcp16502_get_status,
	.set_voltage_time_sel		= mcp16502_set_voltage_time_sel,
	.set_ramp_delay			= mcp16502_set_ramp_delay,

#ifdef CONFIG_SUSPEND
	.set_suspend_voltage		= mcp16502_set_suspend_voltage,
	.set_suspend_enable		= mcp16502_set_suspend_enable,
	.set_suspend_disable		= mcp16502_set_suspend_disable,
#endif /* CONFIG_SUSPEND */
};

static const struct of_device_id mcp16502_ids[] = {
	{ .compatible = "microchip,mcp16502", },
	{}
};
MODULE_DEVICE_TABLE(of, mcp16502_ids);

static const struct linear_range b1l12_ranges[] = {
	REGULATOR_LINEAR_RANGE(1200000, VDD_LOW_SEL, VDD_HIGH_SEL, 50000),
};

static const struct linear_range b234_ranges[] = {
	REGULATOR_LINEAR_RANGE(600000, VDD_LOW_SEL, VDD_HIGH_SEL, 25000),
};

static const struct regulator_desc mcp16502_desc[] = {
	/* MCP16502_REGULATOR(_name, _id, ranges, regulator_ops) */
	MCP16502_REGULATOR("VDD_IO", BUCK1, b1l12_ranges, mcp16502_buck_ops),
	MCP16502_REGULATOR("VDD_DDR", BUCK2, b234_ranges, mcp16502_buck_ops),
	MCP16502_REGULATOR("VDD_CORE", BUCK3, b234_ranges, mcp16502_buck_ops),
	MCP16502_REGULATOR("VDD_OTHER", BUCK4, b234_ranges, mcp16502_buck_ops),
	MCP16502_REGULATOR("LDO1", LDO1, b1l12_ranges, mcp16502_ldo_ops),
	MCP16502_REGULATOR("LDO2", LDO2, b1l12_ranges, mcp16502_ldo_ops)
};

static const struct regmap_range mcp16502_ranges[] = {
	regmap_reg_range(MCP16502_MIN_REG, MCP16502_MAX_REG)
};

static const struct regmap_access_table mcp16502_yes_reg_table = {
	.yes_ranges = mcp16502_ranges,
	.n_yes_ranges = ARRAY_SIZE(mcp16502_ranges),
};

static const struct regmap_config mcp16502_regmap_config = {
	.reg_bits	= 8,
	.val_bits	= 8,
	.max_register	= MCP16502_MAX_REG,
	.cache_type	= REGCACHE_NONE,
	.rd_table	= &mcp16502_yes_reg_table,
	.wr_table	= &mcp16502_yes_reg_table,
};

static int mcp16502_probe(struct i2c_client *client,
			  const struct i2c_device_id *id)
{
	struct regulator_config config = { };
	struct regulator_dev *rdev;
	struct device *dev;
	struct mcp16502 *mcp;
	struct regmap *rmap;
	int i, ret;

	dev = &client->dev;
	config.dev = dev;

	mcp = devm_kzalloc(dev, sizeof(*mcp), GFP_KERNEL);
	if (!mcp)
		return -ENOMEM;

	rmap = devm_regmap_init_i2c(client, &mcp16502_regmap_config);
	if (IS_ERR(rmap)) {
		ret = PTR_ERR(rmap);
		dev_err(dev, "regmap init failed: %d\n", ret);
		return ret;
	}

	i2c_set_clientdata(client, mcp);
	config.regmap = rmap;
	config.driver_data = mcp;

	mcp->lpm = devm_gpiod_get(dev, "lpm", GPIOD_OUT_LOW);
	if (IS_ERR(mcp->lpm)) {
		dev_err(dev, "failed to get lpm pin: %ld\n", PTR_ERR(mcp->lpm));
		return PTR_ERR(mcp->lpm);
	}

	for (i = 0; i < NUM_REGULATORS; i++) {
		rdev = devm_regulator_register(dev, &mcp16502_desc[i], &config);
		if (IS_ERR(rdev)) {
			dev_err(dev,
				"failed to register %s regulator %ld\n",
				mcp16502_desc[i].name, PTR_ERR(rdev));
			return PTR_ERR(rdev);
		}
	}

	mcp16502_gpio_set_mode(mcp, MCP16502_OPMODE_ACTIVE);

	return 0;
}

#ifdef CONFIG_PM_SLEEP
static int mcp16502_suspend_noirq(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct mcp16502 *mcp = i2c_get_clientdata(client);

	mcp16502_gpio_set_mode(mcp, MCP16502_OPMODE_LPM);

	return 0;
}

static int mcp16502_resume_noirq(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct mcp16502 *mcp = i2c_get_clientdata(client);

	mcp16502_gpio_set_mode(mcp, MCP16502_OPMODE_ACTIVE);

	return 0;
}
#endif

#ifdef CONFIG_PM
static const struct dev_pm_ops mcp16502_pm_ops = {
	SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(mcp16502_suspend_noirq,
				      mcp16502_resume_noirq)
};
#endif
static const struct i2c_device_id mcp16502_i2c_id[] = {
	{ "mcp16502", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, mcp16502_i2c_id);

static struct i2c_driver mcp16502_drv = {
	.probe		= mcp16502_probe,
	.driver		= {
		.name	= "mcp16502-regulator",
		.of_match_table	= of_match_ptr(mcp16502_ids),
#ifdef CONFIG_PM
		.pm = &mcp16502_pm_ops,
#endif
	},
	.id_table	= mcp16502_i2c_id,
};

module_i2c_driver(mcp16502_drv);

MODULE_LICENSE("GPL v2");
MODULE_DESCRIPTION("MCP16502 PMIC driver");
MODULE_AUTHOR("Andrei Stefanescu andrei.stefanescu@microchip.com");
Commit	Line	Data
919261c0 AS	1	// SPDX-License-Identifier: GPL-2.0
	2	//
	3	// MCP16502 PMIC driver
	4	//
	5	// Copyright (C) 2018 Microchip Technology Inc. and its subsidiaries
	6	//
	7	// Author: Andrei Stefanescu <andrei.stefanescu@microchip.com>
	8	//
	9	// Inspired from tps65086-regulator.c
	10
	11	#include <linux/gpio.h>
	12	#include <linux/i2c.h>
	13	#include <linux/init.h>
	14	#include <linux/kernel.h>
	15	#include <linux/module.h>
	16	#include <linux/of.h>
	17	#include <linux/regmap.h>
	18	#include <linux/regulator/driver.h>
	19	#include <linux/suspend.h>
f3c6a1a1	20	#include <linux/gpio/consumer.h>
919261c0 AS	21
	22	#define VDD_LOW_SEL 0x0D
	23	#define VDD_HIGH_SEL 0x3F
	24
322eb866 CB	25	#define MCP16502_FLT BIT(7)
	26	#define MCP16502_DVSR GENMASK(3, 2)
	27	#define MCP16502_ENS BIT(0)
919261c0 AS	28
	29	/*
	30	* The PMIC has four sets of registers corresponding to four power modes:
	31	* Performance, Active, Low-power, Hibernate.
	32	*
	33	* Registers:
	34	* Each regulator has a register for each power mode. To access a register
	35	* for a specific regulator and mode BASE_* and OFFSET_* need to be added.
	36	*
	37	* Operating modes:
	38	* In order for the PMIC to transition to operating modes it has to be
	39	* controlled via GPIO lines called LPM and HPM.
	40	*
	41	* The registers are fully configurable such that you can put all regulators in
	42	* a low-power state while the PMIC is in Active mode. They are supposed to be
	43	* configured at startup and then simply transition to/from a global low-power
	44	* state by setting the GPIO lpm pin high/low.
	45	*
	46	* This driver keeps the PMIC in Active mode, Low-power state is set for the
	47	* regulators by enabling/disabling operating mode (FPWM or Auto PFM).
	48	*
	49	* The PMIC's Low-power and Hibernate modes are used during standby/suspend.
	50	* To enter standby/suspend the PMIC will go to Low-power mode. From there, it
	51	* will transition to Hibernate when the PWRHLD line is set to low by the MPU.
	52	*/
	53
	54	/*
	55	* This function is useful for iterating over all regulators and accessing their
	56	* registers in a generic way or accessing a regulator device by its id.
	57	*/
3e5532a0	58	#define MCP16502_REG_BASE(i, r) ((((i) + 1) << 4) + MCP16502_REG_##r)
919261c0 AS	59	#define MCP16502_STAT_BASE(i) ((i) + 5)
919261c0 AS	60
919261c0 AS	61	#define MCP16502_OPMODE_ACTIVE REGULATOR_MODE_NORMAL
	62	#define MCP16502_OPMODE_LPM REGULATOR_MODE_IDLE
	63	#define MCP16502_OPMODE_HIB REGULATOR_MODE_STANDBY
	64
	65	#define MCP16502_MODE_AUTO_PFM 0
	66	#define MCP16502_MODE_FPWM BIT(6)
	67
	68	#define MCP16502_VSEL 0x3F
	69	#define MCP16502_EN BIT(7)
	70	#define MCP16502_MODE BIT(6)
	71
	72	#define MCP16502_MIN_REG 0x0
	73	#define MCP16502_MAX_REG 0x65
	74
3e5532a0 CB	75	/**
	76	* enum mcp16502_reg - MCP16502 regulators's registers
	77	* @MCP16502_REG_A: active state register
	78	* @MCP16502_REG_LPM: low power mode state register
	79	* @MCP16502_REG_HIB: hibernate state register
	80	* @MCP16502_REG_SEQ: startup sequence register
	81	* @MCP16502_REG_CFG: configuration register
	82	*/
	83	enum mcp16502_reg {
	84	MCP16502_REG_A,
	85	MCP16502_REG_LPM,
	86	MCP16502_REG_HIB,
	87	MCP16502_REG_HPM,
	88	MCP16502_REG_SEQ,
	89	MCP16502_REG_CFG,
	90	};
	91
322eb866 CB	92	/* Ramp delay (uV/us) for buck1, ldo1, ldo2. */
	93	static const int mcp16502_ramp_b1l12[] = { 6250, 3125, 2083, 1563 };
	94
	95	/* Ramp delay (uV/us) for buck2, buck3, buck4. */
	96	static const int mcp16502_ramp_b234[] = { 3125, 1563, 1042, 781 };
	97
919261c0 AS	98	static unsigned int mcp16502_of_map_mode(unsigned int mode)
	99	{
	100	if (mode == REGULATOR_MODE_NORMAL \|\| mode == REGULATOR_MODE_IDLE)
	101	return mode;
	102
	103	return REGULATOR_MODE_INVALID;
	104	}
	105
	106	#define MCP16502_REGULATOR(_name, _id, _ranges, _ops) \
	107	[_id] = { \
	108	.name = _name, \
	109	.regulators_node = of_match_ptr("regulators"), \
	110	.id = _id, \
	111	.ops = &(_ops), \
	112	.type = REGULATOR_VOLTAGE, \
	113	.owner = THIS_MODULE, \
f4c8f980	114	.n_voltages = MCP16502_VSEL + 1, \
919261c0	115	.linear_ranges = _ranges, \
478f8089	116	.linear_min_sel = VDD_LOW_SEL, \
919261c0 AS	117	.n_linear_ranges = ARRAY_SIZE(_ranges), \
	118	.of_match = of_match_ptr(_name), \
	119	.of_map_mode = mcp16502_of_map_mode, \
	120	.vsel_reg = (((_id) + 1) << 4), \
	121	.vsel_mask = MCP16502_VSEL, \
	122	.enable_reg = (((_id) + 1) << 4), \
	123	.enable_mask = MCP16502_EN, \
	124	}
	125
	126	enum {
	127	BUCK1 = 0,
	128	BUCK2,
	129	BUCK3,
	130	BUCK4,
	131	LDO1,
	132	LDO2,
	133	NUM_REGULATORS
	134	};
	135
	136	/*
	137	* struct mcp16502 - PMIC representation
919261c0 AS	138	* @lpm: LPM GPIO descriptor
	139	*/
	140	struct mcp16502 {
919261c0 AS	141	struct gpio_desc *lpm;
	142	};
	143
	144	/*
	145	* mcp16502_gpio_set_mode() - set the GPIO corresponding value
	146	*
	147	* Used to prepare transitioning into hibernate or resuming from it.
	148	*/
	149	static void mcp16502_gpio_set_mode(struct mcp16502 *mcp, int mode)
	150	{
	151	switch (mode) {
	152	case MCP16502_OPMODE_ACTIVE:
	153	gpiod_set_value(mcp->lpm, 0);
	154	break;
	155	case MCP16502_OPMODE_LPM:
	156	case MCP16502_OPMODE_HIB:
	157	gpiod_set_value(mcp->lpm, 1);
	158	break;
	159	default:
	160	pr_err("%s: %d invalid\n", __func__, mode);
	161	}
	162	}
	163
	164	/*
3e5532a0	165	* mcp16502_get_reg() - get the PMIC's state configuration register for opmode
919261c0 AS	166	*
	167	* @rdev: the regulator whose register we are searching
	168	* @opmode: the PMIC's operating mode ACTIVE, Low-power, Hibernate
	169	*/
3e5532a0	170	static int mcp16502_get_state_reg(struct regulator_dev *rdev, int opmode)
919261c0	171	{
919261c0 AS	172	switch (opmode) {
919261c0 AS	173	case MCP16502_OPMODE_ACTIVE:
3e5532a0	174	return MCP16502_REG_BASE(rdev_get_id(rdev), A);
919261c0	175	case MCP16502_OPMODE_LPM:
3e5532a0	176	return MCP16502_REG_BASE(rdev_get_id(rdev), LPM);
919261c0	177	case MCP16502_OPMODE_HIB:
3e5532a0	178	return MCP16502_REG_BASE(rdev_get_id(rdev), HIB);
919261c0 AS	179	default:
	180	return -EINVAL;
	181	}
	182	}
	183
	184	/*
	185	* mcp16502_get_mode() - return the current operating mode of a regulator
	186	*
	187	* Note: all functions that are not part of entering/exiting standby/suspend
	188	* use the Active mode registers.
	189	*
	190	* Note: this is different from the PMIC's operatig mode, it is the
	191	* MODE bit from the regulator's register.
	192	*/
	193	static unsigned int mcp16502_get_mode(struct regulator_dev *rdev)
	194	{
	195	unsigned int val;
	196	int ret, reg;
919261c0	197
3e5532a0	198	reg = mcp16502_get_state_reg(rdev, MCP16502_OPMODE_ACTIVE);
919261c0 AS	199	if (reg < 0)
	200	return reg;
	201
4cf46953	202	ret = regmap_read(rdev->regmap, reg, &val);
919261c0 AS	203	if (ret)
	204	return ret;
	205
	206	switch (val & MCP16502_MODE) {
	207	case MCP16502_MODE_FPWM:
	208	return REGULATOR_MODE_NORMAL;
	209	case MCP16502_MODE_AUTO_PFM:
	210	return REGULATOR_MODE_IDLE;
	211	default:
	212	return REGULATOR_MODE_INVALID;
	213	}
	214	}
	215
	216	/*
	217	* _mcp16502_set_mode() - helper for set_mode and set_suspend_mode
	218	*
	219	* @rdev: the regulator for which we are setting the mode
	220	* @mode: the regulator's mode (the one from MODE bit)
	221	* @opmode: the PMIC's operating mode: Active/Low-power/Hibernate
	222	*/
	223	static int _mcp16502_set_mode(struct regulator_dev *rdev, unsigned int mode,
	224	unsigned int op_mode)
	225	{
	226	int val;
	227	int reg;
919261c0	228
3e5532a0	229	reg = mcp16502_get_state_reg(rdev, op_mode);
919261c0 AS	230	if (reg < 0)
	231	return reg;
	232
	233	switch (mode) {
	234	case REGULATOR_MODE_NORMAL:
	235	val = MCP16502_MODE_FPWM;
	236	break;
	237	case REGULATOR_MODE_IDLE:
	238	val = MCP16502_MODE_AUTO_PFM;
	239	break;
	240	default:
	241	return -EINVAL;
	242	}
	243
4cf46953	244	reg = regmap_update_bits(rdev->regmap, reg, MCP16502_MODE, val);
919261c0 AS	245	return reg;
	246	}
	247
	248	/*
	249	* mcp16502_set_mode() - regulator_ops set_mode
	250	*/
	251	static int mcp16502_set_mode(struct regulator_dev *rdev, unsigned int mode)
	252	{
	253	return _mcp16502_set_mode(rdev, mode, MCP16502_OPMODE_ACTIVE);
	254	}
	255
	256	/*
	257	* mcp16502_get_status() - regulator_ops get_status
	258	*/
	259	static int mcp16502_get_status(struct regulator_dev *rdev)
	260	{
	261	int ret;
	262	unsigned int val;
919261c0	263
4cf46953	264	ret = regmap_read(rdev->regmap, MCP16502_STAT_BASE(rdev_get_id(rdev)),
919261c0 AS	265	&val);
	266	if (ret)
	267	return ret;
	268
	269	if (val & MCP16502_FLT)
	270	return REGULATOR_STATUS_ERROR;
	271	else if (val & MCP16502_ENS)
	272	return REGULATOR_STATUS_ON;
	273	else if (!(val & MCP16502_ENS))
	274	return REGULATOR_STATUS_OFF;
	275
	276	return REGULATOR_STATUS_UNDEFINED;
	277	}
	278
322eb866 CB	279	static int mcp16502_set_voltage_time_sel(struct regulator_dev *rdev,
	280	unsigned int old_sel,
	281	unsigned int new_sel)
	282	{
	283	static const u8 us_ramp[] = { 8, 16, 24, 32 };
	284	int id = rdev_get_id(rdev);
	285	unsigned int uV_delta, val;
	286	int ret;
	287
	288	ret = regmap_read(rdev->regmap, MCP16502_REG_BASE(id, CFG), &val);
	289	if (ret)
	290	return ret;
	291
	292	val = (val & MCP16502_DVSR) >> 2;
	293	uV_delta = abs(new_sel * rdev->desc->linear_ranges->step -
	294	old_sel * rdev->desc->linear_ranges->step);
	295	switch (id) {
	296	case BUCK1:
	297	case LDO1:
	298	case LDO2:
	299	ret = DIV_ROUND_CLOSEST(uV_delta * us_ramp[val],
	300	mcp16502_ramp_b1l12[val]);
	301	break;
	302
	303	case BUCK2:
	304	case BUCK3:
	305	case BUCK4:
	306	ret = DIV_ROUND_CLOSEST(uV_delta * us_ramp[val],
	307	mcp16502_ramp_b234[val]);
	308	break;
	309
	310	default:
	311	return -EINVAL;
	312	}
	313
	314	return ret;
	315	}
	316
	317	static int mcp16502_set_ramp_delay(struct regulator_dev *rdev, int ramp_delay)
	318	{
	319	const int *ramp;
	320	int id = rdev_get_id(rdev);
	321	unsigned int i, size;
	322
	323	switch (id) {
	324	case BUCK1:
	325	case LDO1:
	326	case LDO2:
	327	ramp = mcp16502_ramp_b1l12;
	328	size = ARRAY_SIZE(mcp16502_ramp_b1l12);
	329	break;
	330
	331	case BUCK2:
	332	case BUCK3:
	333	case BUCK4:
	334	ramp = mcp16502_ramp_b234;
	335	size = ARRAY_SIZE(mcp16502_ramp_b234);
	336	break;
	337
	338	default:
	339	return -EINVAL;
	340	}
	341
	342	for (i = 0; i < size; i++) {
343	if (ramp[i] == ramp_delay)
344	break;
345	}
346	if (i == size)
347	return -EINVAL;
348
349	return regmap_update_bits(rdev->regmap, MCP16502_REG_BASE(id, CFG),
350	MCP16502_DVSR, (i << 2));
351	}
352
919261c0 AS	353	#ifdef CONFIG_SUSPEND
	354	/*
	355	* mcp16502_suspend_get_target_reg() - get the reg of the target suspend PMIC
	356	* mode
	357	*/
	358	static int mcp16502_suspend_get_target_reg(struct regulator_dev *rdev)
	359	{
	360	switch (pm_suspend_target_state) {
	361	case PM_SUSPEND_STANDBY:
3e5532a0	362	return mcp16502_get_state_reg(rdev, MCP16502_OPMODE_LPM);
919261c0 AS	363	case PM_SUSPEND_ON:
919261c0 AS	364	case PM_SUSPEND_MEM:
3e5532a0	365	return mcp16502_get_state_reg(rdev, MCP16502_OPMODE_HIB);
919261c0 AS	366	default:
	367	dev_err(&rdev->dev, "invalid suspend target: %d\n",
	368	pm_suspend_target_state);
	369	}
	370
	371	return -EINVAL;
	372	}
	373
	374	/*
	375	* mcp16502_set_suspend_voltage() - regulator_ops set_suspend_voltage
	376	*/
	377	static int mcp16502_set_suspend_voltage(struct regulator_dev *rdev, int uV)
	378	{
919261c0 AS	379	int sel = regulator_map_voltage_linear_range(rdev, uV, uV);
	380	int reg = mcp16502_suspend_get_target_reg(rdev);
	381
	382	if (sel < 0)
	383	return sel;
	384
	385	if (reg < 0)
	386	return reg;
	387
4cf46953	388	return regmap_update_bits(rdev->regmap, reg, MCP16502_VSEL, sel);
919261c0 AS	389	}
	390
	391	/*
	392	* mcp16502_set_suspend_mode() - regulator_ops set_suspend_mode
	393	*/
	394	static int mcp16502_set_suspend_mode(struct regulator_dev *rdev,
	395	unsigned int mode)
	396	{
	397	switch (pm_suspend_target_state) {
	398	case PM_SUSPEND_STANDBY:
	399	return _mcp16502_set_mode(rdev, mode, MCP16502_OPMODE_LPM);
	400	case PM_SUSPEND_ON:
	401	case PM_SUSPEND_MEM:
	402	return _mcp16502_set_mode(rdev, mode, MCP16502_OPMODE_HIB);
	403	default:
	404	dev_err(&rdev->dev, "invalid suspend target: %d\n",
	405	pm_suspend_target_state);
	406	}
	407
	408	return -EINVAL;
	409	}
	410
	411	/*
	412	* mcp16502_set_suspend_enable() - regulator_ops set_suspend_enable
	413	*/
	414	static int mcp16502_set_suspend_enable(struct regulator_dev *rdev)
	415	{
919261c0 AS	416	int reg = mcp16502_suspend_get_target_reg(rdev);
	417
	418	if (reg < 0)
	419	return reg;
	420
4cf46953	421	return regmap_update_bits(rdev->regmap, reg, MCP16502_EN, MCP16502_EN);
919261c0 AS	422	}
	423
	424	/*
	425	* mcp16502_set_suspend_disable() - regulator_ops set_suspend_disable
	426	*/
	427	static int mcp16502_set_suspend_disable(struct regulator_dev *rdev)
	428	{
919261c0 AS	429	int reg = mcp16502_suspend_get_target_reg(rdev);
	430
	431	if (reg < 0)
	432	return reg;
	433
4cf46953	434	return regmap_update_bits(rdev->regmap, reg, MCP16502_EN, 0);
919261c0 AS	435	}
	436	#endif /* CONFIG_SUSPEND */
	437
	438	static const struct regulator_ops mcp16502_buck_ops = {
	439	.list_voltage = regulator_list_voltage_linear_range,
	440	.map_voltage = regulator_map_voltage_linear_range,
	441	.get_voltage_sel = regulator_get_voltage_sel_regmap,
	442	.set_voltage_sel = regulator_set_voltage_sel_regmap,
	443	.enable = regulator_enable_regmap,
	444	.disable = regulator_disable_regmap,
	445	.is_enabled = regulator_is_enabled_regmap,
	446	.get_status = mcp16502_get_status,
322eb866 CB	447	.set_voltage_time_sel = mcp16502_set_voltage_time_sel,
322eb866 CB	448	.set_ramp_delay = mcp16502_set_ramp_delay,
919261c0 AS	449
	450	.set_mode = mcp16502_set_mode,
	451	.get_mode = mcp16502_get_mode,
	452
	453	#ifdef CONFIG_SUSPEND
	454	.set_suspend_voltage = mcp16502_set_suspend_voltage,
	455	.set_suspend_mode = mcp16502_set_suspend_mode,
	456	.set_suspend_enable = mcp16502_set_suspend_enable,
	457	.set_suspend_disable = mcp16502_set_suspend_disable,
	458	#endif /* CONFIG_SUSPEND */
	459	};
	460
	461	/*
	462	* LDOs cannot change operating modes.
	463	*/
	464	static const struct regulator_ops mcp16502_ldo_ops = {
	465	.list_voltage = regulator_list_voltage_linear_range,
	466	.map_voltage = regulator_map_voltage_linear_range,
	467	.get_voltage_sel = regulator_get_voltage_sel_regmap,
	468	.set_voltage_sel = regulator_set_voltage_sel_regmap,
	469	.enable = regulator_enable_regmap,
	470	.disable = regulator_disable_regmap,
	471	.is_enabled = regulator_is_enabled_regmap,
	472	.get_status = mcp16502_get_status,
322eb866 CB	473	.set_voltage_time_sel = mcp16502_set_voltage_time_sel,
322eb866 CB	474	.set_ramp_delay = mcp16502_set_ramp_delay,
919261c0 AS	475
	476	#ifdef CONFIG_SUSPEND
	477	.set_suspend_voltage = mcp16502_set_suspend_voltage,
	478	.set_suspend_enable = mcp16502_set_suspend_enable,
	479	.set_suspend_disable = mcp16502_set_suspend_disable,
	480	#endif /* CONFIG_SUSPEND */
	481	};
	482
	483	static const struct of_device_id mcp16502_ids[] = {
	484	{ .compatible = "microchip,mcp16502", },
	485	{}
	486	};
	487	MODULE_DEVICE_TABLE(of, mcp16502_ids);
	488
60ab7f41	489	static const struct linear_range b1l12_ranges[] = {
919261c0 AS	490	REGULATOR_LINEAR_RANGE(1200000, VDD_LOW_SEL, VDD_HIGH_SEL, 50000),
	491	};
	492
60ab7f41	493	static const struct linear_range b234_ranges[] = {
919261c0 AS	494	REGULATOR_LINEAR_RANGE(600000, VDD_LOW_SEL, VDD_HIGH_SEL, 25000),
	495	};
	496
	497	static const struct regulator_desc mcp16502_desc[] = {
	498	/* MCP16502_REGULATOR(_name, _id, ranges, regulator_ops) */
	499	MCP16502_REGULATOR("VDD_IO", BUCK1, b1l12_ranges, mcp16502_buck_ops),
	500	MCP16502_REGULATOR("VDD_DDR", BUCK2, b234_ranges, mcp16502_buck_ops),
	501	MCP16502_REGULATOR("VDD_CORE", BUCK3, b234_ranges, mcp16502_buck_ops),
	502	MCP16502_REGULATOR("VDD_OTHER", BUCK4, b234_ranges, mcp16502_buck_ops),
	503	MCP16502_REGULATOR("LDO1", LDO1, b1l12_ranges, mcp16502_ldo_ops),
	504	MCP16502_REGULATOR("LDO2", LDO2, b1l12_ranges, mcp16502_ldo_ops)
	505	};
	506
	507	static const struct regmap_range mcp16502_ranges[] = {
	508	regmap_reg_range(MCP16502_MIN_REG, MCP16502_MAX_REG)
	509	};
	510
	511	static const struct regmap_access_table mcp16502_yes_reg_table = {
	512	.yes_ranges = mcp16502_ranges,
	513	.n_yes_ranges = ARRAY_SIZE(mcp16502_ranges),
	514	};
	515
	516	static const struct regmap_config mcp16502_regmap_config = {
	517	.reg_bits = 8,
	518	.val_bits = 8,
	519	.max_register = MCP16502_MAX_REG,
	520	.cache_type = REGCACHE_NONE,
	521	.rd_table = &mcp16502_yes_reg_table,
	522	.wr_table = &mcp16502_yes_reg_table,
	523	};
	524
919261c0 AS	525	static int mcp16502_probe(struct i2c_client *client,
	526	const struct i2c_device_id *id)
	527	{
	528	struct regulator_config config = { };
784c24c3	529	struct regulator_dev *rdev;
919261c0 AS	530	struct device *dev;
919261c0 AS	531	struct mcp16502 *mcp;
4cf46953	532	struct regmap *rmap;
784c24c3	533	int i, ret;
919261c0 AS	534
	535	dev = &client->dev;
	536	config.dev = dev;
	537
	538	mcp = devm_kzalloc(dev, sizeof(*mcp), GFP_KERNEL);
	539	if (!mcp)
	540	return -ENOMEM;
	541
4cf46953 AL	542	rmap = devm_regmap_init_i2c(client, &mcp16502_regmap_config);
	543	if (IS_ERR(rmap)) {
	544	ret = PTR_ERR(rmap);
919261c0 AS	545	dev_err(dev, "regmap init failed: %d\n", ret);
	546	return ret;
	547	}
	548
	549	i2c_set_clientdata(client, mcp);
4cf46953	550	config.regmap = rmap;
919261c0 AS	551	config.driver_data = mcp;
	552
	553	mcp->lpm = devm_gpiod_get(dev, "lpm", GPIOD_OUT_LOW);
	554	if (IS_ERR(mcp->lpm)) {
	555	dev_err(dev, "failed to get lpm pin: %ld\n", PTR_ERR(mcp->lpm));
	556	return PTR_ERR(mcp->lpm);
	557	}
	558
784c24c3 AL	559	for (i = 0; i < NUM_REGULATORS; i++) {
	560	rdev = devm_regulator_register(dev, &mcp16502_desc[i], &config);
	561	if (IS_ERR(rdev)) {
	562	dev_err(dev,
	563	"failed to register %s regulator %ld\n",
	564	mcp16502_desc[i].name, PTR_ERR(rdev));
	565	return PTR_ERR(rdev);
	566	}
	567	}
919261c0 AS	568
	569	mcp16502_gpio_set_mode(mcp, MCP16502_OPMODE_ACTIVE);
	570
	571	return 0;
	572	}
	573
4906d091	574	#ifdef CONFIG_PM_SLEEP
fc401cb9 AS	575	static int mcp16502_suspend_noirq(struct device *dev)
	576	{
	577	struct i2c_client *client = to_i2c_client(dev);
	578	struct mcp16502 *mcp = i2c_get_clientdata(client);
	579
	580	mcp16502_gpio_set_mode(mcp, MCP16502_OPMODE_LPM);
	581
	582	return 0;
	583	}
	584
	585	static int mcp16502_resume_noirq(struct device *dev)
	586	{
	587	struct i2c_client *client = to_i2c_client(dev);
	588	struct mcp16502 *mcp = i2c_get_clientdata(client);
	589
	590	mcp16502_gpio_set_mode(mcp, MCP16502_OPMODE_ACTIVE);
	591
	592	return 0;
	593	}
4906d091	594	#endif
fc401cb9 AS	595
	596	#ifdef CONFIG_PM
	597	static const struct dev_pm_ops mcp16502_pm_ops = {
	598	SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(mcp16502_suspend_noirq,
308144ce	599	mcp16502_resume_noirq)
fc401cb9 AS	600	};
fc401cb9 AS	601	#endif
919261c0 AS	602	static const struct i2c_device_id mcp16502_i2c_id[] = {
	603	{ "mcp16502", 0 },
	604	{ }
	605	};
	606	MODULE_DEVICE_TABLE(i2c, mcp16502_i2c_id);
	607
	608	static struct i2c_driver mcp16502_drv = {
	609	.probe = mcp16502_probe,
	610	.driver = {
	611	.name = "mcp16502-regulator",
	612	.of_match_table = of_match_ptr(mcp16502_ids),
fc401cb9 AS	613	#ifdef CONFIG_PM
	614	.pm = &mcp16502_pm_ops,
	615	#endif
919261c0 AS	616	},
	617	.id_table = mcp16502_i2c_id,
	618	};
	619
	620	module_i2c_driver(mcp16502_drv);
	621
919261c0 AS	622	MODULE_LICENSE("GPL v2");
	623	MODULE_DESCRIPTION("MCP16502 PMIC driver");
	624	MODULE_AUTHOR("Andrei Stefanescu andrei.stefanescu@microchip.com");