[deliverable/linux.git] / drivers / regulator / max77686.c

/*
 * max77686.c - Regulator driver for the Maxim 77686
 *
 * Copyright (C) 2012 Samsung Electronics
 * Chiwoong Byun <woong.byun@smasung.com>
 * Jonghwa Lee <jonghwa3.lee@samsung.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * This driver is based on max8997.c
 */

#include <linux/kernel.h>
#include <linux/bug.h>
#include <linux/delay.h>
#include <linux/err.h>
#include <linux/gpio.h>
#include <linux/slab.h>
#include <linux/platform_device.h>
#include <linux/regulator/driver.h>
#include <linux/regulator/machine.h>
#include <linux/regulator/of_regulator.h>
#include <linux/mfd/max77686.h>
#include <linux/mfd/max77686-private.h>

#define MAX77686_LDO_MINUV	800000
#define MAX77686_LDO_UVSTEP	50000
#define MAX77686_LDO_LOW_MINUV	800000
#define MAX77686_LDO_LOW_UVSTEP	25000
#define MAX77686_BUCK_MINUV	750000
#define MAX77686_BUCK_UVSTEP	50000
#define MAX77686_RAMP_DELAY	100000			/* uV/us */
#define MAX77686_DVS_RAMP_DELAY	27500			/* uV/us */
#define MAX77686_DVS_MINUV	600000
#define MAX77686_DVS_UVSTEP	12500

#define MAX77686_OPMODE_SHIFT	6
#define MAX77686_OPMODE_BUCK234_SHIFT	4
#define MAX77686_OPMODE_MASK	0x3

#define MAX77686_VSEL_MASK	0x3F
#define MAX77686_DVS_VSEL_MASK	0xFF

#define MAX77686_RAMP_RATE_MASK	0xC0

#define MAX77686_REGULATORS	MAX77686_REG_MAX
#define MAX77686_LDOS		26

enum max77686_ramp_rate {
	RAMP_RATE_13P75MV,
	RAMP_RATE_27P5MV,
	RAMP_RATE_55MV,
	RAMP_RATE_NO_CTRL,	/* 100mV/us */
};

struct max77686_data {
	struct regulator_dev *rdev[MAX77686_REGULATORS];
	unsigned int opmode[MAX77686_REGULATORS];
};

/* Some BUCKS supports Normal[ON/OFF] mode during suspend */
static int max77686_buck_set_suspend_disable(struct regulator_dev *rdev)
{
	unsigned int val;
	struct max77686_data *max77686 = rdev_get_drvdata(rdev);
        int id = rdev_get_id(rdev);

	if (id == MAX77686_BUCK1)
		val = 0x1;
	else
		val = 0x1 << MAX77686_OPMODE_BUCK234_SHIFT;

	max77686->opmode[id] = val;
	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
				  rdev->desc->enable_mask,
				  val);
}

/* Some LDOs supports [LPM/Normal]ON mode during suspend state */
static int max77686_set_suspend_mode(struct regulator_dev *rdev,
				     unsigned int mode)
{
	struct max77686_data *max77686 = rdev_get_drvdata(rdev);
	unsigned int val;
        int id = rdev_get_id(rdev);

	/* BUCK[5-9] doesn't support this feature */
	if (id >= MAX77686_BUCK5)
		return 0;

	switch (mode) {
	case REGULATOR_MODE_IDLE:			/* ON in LP Mode */
		val = 0x2 << MAX77686_OPMODE_SHIFT;
		break;
	case REGULATOR_MODE_NORMAL:			/* ON in Normal Mode */
		val = 0x3 << MAX77686_OPMODE_SHIFT;
		break;
	default:
		pr_warn("%s: regulator_suspend_mode : 0x%x not supported\n",
			rdev->desc->name, mode);
		return -EINVAL;
	}

	max77686->opmode[id] = val;
	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
				  rdev->desc->enable_mask,
				  val);
}

/* Some LDOs supports LPM-ON/OFF/Normal-ON mode during suspend state */
static int max77686_ldo_set_suspend_mode(struct regulator_dev *rdev,
				     unsigned int mode)
{
	unsigned int val;
	struct max77686_data *max77686 = rdev_get_drvdata(rdev);

	switch (mode) {
	case REGULATOR_MODE_STANDBY:			/* switch off */
		val = 0x1 << MAX77686_OPMODE_SHIFT;
		break;
	case REGULATOR_MODE_IDLE:			/* ON in LP Mode */
		val = 0x2 << MAX77686_OPMODE_SHIFT;
		break;
	case REGULATOR_MODE_NORMAL:			/* ON in Normal Mode */
		val = 0x3 << MAX77686_OPMODE_SHIFT;
		break;
	default:
		pr_warn("%s: regulator_suspend_mode : 0x%x not supported\n",
			rdev->desc->name, mode);
		return -EINVAL;
	}

	max77686->opmode[rdev_get_id(rdev)] = val;
	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
				  rdev->desc->enable_mask,
				  val);
}

static int max77686_enable(struct regulator_dev *rdev)
{
	struct max77686_data *max77686 = rdev_get_drvdata(rdev);

	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
				  rdev->desc->enable_mask,
				  max77686->opmode[rdev_get_id(rdev)]);
}

static int max77686_set_ramp_delay(struct regulator_dev *rdev, int ramp_delay)
{
	unsigned int ramp_value = RAMP_RATE_NO_CTRL;

	switch (ramp_delay) {
	case 1 ... 13750:
		ramp_value = RAMP_RATE_13P75MV;
		break;
	case 13751 ... 27500:
		ramp_value = RAMP_RATE_27P5MV;
		break;
	case 27501 ... 55000:
		ramp_value = RAMP_RATE_55MV;
		break;
	case 55001 ... 100000:
		break;
	default:
		pr_warn("%s: ramp_delay: %d not supported, setting 100000\n",
			rdev->desc->name, ramp_delay);
	}

	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
				  MAX77686_RAMP_RATE_MASK, ramp_value << 6);
}

static struct regulator_ops max77686_ops = {
	.list_voltage		= regulator_list_voltage_linear,
	.map_voltage		= regulator_map_voltage_linear,
	.is_enabled		= regulator_is_enabled_regmap,
	.enable			= max77686_enable,
	.disable		= regulator_disable_regmap,
	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
	.set_voltage_sel	= regulator_set_voltage_sel_regmap,
	.set_voltage_time_sel	= regulator_set_voltage_time_sel,
	.set_suspend_mode	= max77686_set_suspend_mode,
};

static struct regulator_ops max77686_ldo_ops = {
	.list_voltage		= regulator_list_voltage_linear,
	.map_voltage		= regulator_map_voltage_linear,
	.is_enabled		= regulator_is_enabled_regmap,
	.enable			= max77686_enable,
	.disable		= regulator_disable_regmap,
	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
	.set_voltage_sel	= regulator_set_voltage_sel_regmap,
	.set_voltage_time_sel	= regulator_set_voltage_time_sel,
	.set_suspend_mode	= max77686_ldo_set_suspend_mode,
};

static struct regulator_ops max77686_buck1_ops = {
	.list_voltage		= regulator_list_voltage_linear,
	.map_voltage		= regulator_map_voltage_linear,
	.is_enabled		= regulator_is_enabled_regmap,
	.enable			= max77686_enable,
	.disable		= regulator_disable_regmap,
	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
	.set_voltage_sel	= regulator_set_voltage_sel_regmap,
	.set_voltage_time_sel	= regulator_set_voltage_time_sel,
	.set_suspend_disable	= max77686_buck_set_suspend_disable,
};

static struct regulator_ops max77686_buck_dvs_ops = {
	.list_voltage		= regulator_list_voltage_linear,
	.map_voltage		= regulator_map_voltage_linear,
	.is_enabled		= regulator_is_enabled_regmap,
	.enable			= max77686_enable,
	.disable		= regulator_disable_regmap,
	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
	.set_voltage_sel	= regulator_set_voltage_sel_regmap,
	.set_voltage_time_sel	= regulator_set_voltage_time_sel,
	.set_ramp_delay		= max77686_set_ramp_delay,
	.set_suspend_disable	= max77686_buck_set_suspend_disable,
};

#define regulator_desc_ldo(num)		{				\
	.name		= "LDO"#num,					\
	.id		= MAX77686_LDO##num,				\
	.ops		= &max77686_ops,				\
	.type		= REGULATOR_VOLTAGE,				\
	.owner		= THIS_MODULE,					\
	.min_uV		= MAX77686_LDO_MINUV,				\
	.uV_step	= MAX77686_LDO_UVSTEP,				\
	.ramp_delay	= MAX77686_RAMP_DELAY,				\
	.n_voltages	= MAX77686_VSEL_MASK + 1,			\
	.vsel_reg	= MAX77686_REG_LDO1CTRL1 + num - 1,		\
	.vsel_mask	= MAX77686_VSEL_MASK,				\
	.enable_reg	= MAX77686_REG_LDO1CTRL1 + num - 1,		\
	.enable_mask	= MAX77686_OPMODE_MASK				\
			<< MAX77686_OPMODE_SHIFT,			\
}
#define regulator_desc_lpm_ldo(num)	{				\
	.name		= "LDO"#num,					\
	.id		= MAX77686_LDO##num,				\
	.ops		= &max77686_ldo_ops,				\
	.type		= REGULATOR_VOLTAGE,				\
	.owner		= THIS_MODULE,					\
	.min_uV		= MAX77686_LDO_MINUV,				\
	.uV_step	= MAX77686_LDO_UVSTEP,				\
	.ramp_delay	= MAX77686_RAMP_DELAY,				\
	.n_voltages	= MAX77686_VSEL_MASK + 1,			\
	.vsel_reg	= MAX77686_REG_LDO1CTRL1 + num - 1,		\
	.vsel_mask	= MAX77686_VSEL_MASK,				\
	.enable_reg	= MAX77686_REG_LDO1CTRL1 + num - 1,		\
	.enable_mask	= MAX77686_OPMODE_MASK				\
			<< MAX77686_OPMODE_SHIFT,			\
}
#define regulator_desc_ldo_low(num)		{			\
	.name		= "LDO"#num,					\
	.id		= MAX77686_LDO##num,				\
	.ops		= &max77686_ldo_ops,				\
	.type		= REGULATOR_VOLTAGE,				\
	.owner		= THIS_MODULE,					\
	.min_uV		= MAX77686_LDO_LOW_MINUV,			\
	.uV_step	= MAX77686_LDO_LOW_UVSTEP,			\
	.ramp_delay	= MAX77686_RAMP_DELAY,				\
	.n_voltages	= MAX77686_VSEL_MASK + 1,			\
	.vsel_reg	= MAX77686_REG_LDO1CTRL1 + num - 1,		\
	.vsel_mask	= MAX77686_VSEL_MASK,				\
	.enable_reg	= MAX77686_REG_LDO1CTRL1 + num - 1,		\
	.enable_mask	= MAX77686_OPMODE_MASK				\
			<< MAX77686_OPMODE_SHIFT,			\
}
#define regulator_desc_ldo1_low(num)		{			\
	.name		= "LDO"#num,					\
	.id		= MAX77686_LDO##num,				\
	.ops		= &max77686_ops,				\
	.type		= REGULATOR_VOLTAGE,				\
	.owner		= THIS_MODULE,					\
	.min_uV		= MAX77686_LDO_LOW_MINUV,			\
	.uV_step	= MAX77686_LDO_LOW_UVSTEP,			\
	.ramp_delay	= MAX77686_RAMP_DELAY,				\
	.n_voltages	= MAX77686_VSEL_MASK + 1,			\
	.vsel_reg	= MAX77686_REG_LDO1CTRL1 + num - 1,		\
	.vsel_mask	= MAX77686_VSEL_MASK,				\
	.enable_reg	= MAX77686_REG_LDO1CTRL1 + num - 1,		\
	.enable_mask	= MAX77686_OPMODE_MASK				\
			<< MAX77686_OPMODE_SHIFT,			\
}
#define regulator_desc_buck(num)		{			\
	.name		= "BUCK"#num,					\
	.id		= MAX77686_BUCK##num,				\
	.ops		= &max77686_ops,				\
	.type		= REGULATOR_VOLTAGE,				\
	.owner		= THIS_MODULE,					\
	.min_uV		= MAX77686_BUCK_MINUV,				\
	.uV_step	= MAX77686_BUCK_UVSTEP,				\
	.ramp_delay	= MAX77686_RAMP_DELAY,				\
	.n_voltages	= MAX77686_VSEL_MASK + 1,			\
	.vsel_reg	= MAX77686_REG_BUCK5OUT + (num - 5) * 2,	\
	.vsel_mask	= MAX77686_VSEL_MASK,				\
	.enable_reg	= MAX77686_REG_BUCK5CTRL + (num - 5) * 2,	\
	.enable_mask	= MAX77686_OPMODE_MASK,				\
}
#define regulator_desc_buck1(num)		{			\
	.name		= "BUCK"#num,					\
	.id		= MAX77686_BUCK##num,				\
	.ops		= &max77686_buck1_ops,				\
	.type		= REGULATOR_VOLTAGE,				\
	.owner		= THIS_MODULE,					\
	.min_uV		= MAX77686_BUCK_MINUV,				\
	.uV_step	= MAX77686_BUCK_UVSTEP,				\
	.ramp_delay	= MAX77686_RAMP_DELAY,				\
	.n_voltages	= MAX77686_VSEL_MASK + 1,			\
	.vsel_reg	= MAX77686_REG_BUCK1OUT,			\
	.vsel_mask	= MAX77686_VSEL_MASK,				\
	.enable_reg	= MAX77686_REG_BUCK1CTRL,			\
	.enable_mask	= MAX77686_OPMODE_MASK,				\
}
#define regulator_desc_buck_dvs(num)		{			\
	.name		= "BUCK"#num,					\
	.id		= MAX77686_BUCK##num,				\
	.ops		= &max77686_buck_dvs_ops,			\
	.type		= REGULATOR_VOLTAGE,				\
	.owner		= THIS_MODULE,					\
	.min_uV		= MAX77686_DVS_MINUV,				\
	.uV_step	= MAX77686_DVS_UVSTEP,				\
	.ramp_delay	= MAX77686_DVS_RAMP_DELAY,			\
	.n_voltages	= MAX77686_DVS_VSEL_MASK + 1,			\
	.vsel_reg	= MAX77686_REG_BUCK2DVS1 + (num - 2) * 10,	\
	.vsel_mask	= MAX77686_DVS_VSEL_MASK,			\
	.enable_reg	= MAX77686_REG_BUCK2CTRL1 + (num - 2) * 10,	\
	.enable_mask	= MAX77686_OPMODE_MASK				\
			<< MAX77686_OPMODE_BUCK234_SHIFT,		\
}

static struct regulator_desc regulators[] = {
	regulator_desc_ldo1_low(1),
	regulator_desc_ldo_low(2),
	regulator_desc_ldo(3),
	regulator_desc_ldo(4),
	regulator_desc_ldo(5),
	regulator_desc_ldo_low(6),
	regulator_desc_ldo_low(7),
	regulator_desc_ldo_low(8),
	regulator_desc_ldo(9),
	regulator_desc_lpm_ldo(10),
	regulator_desc_lpm_ldo(11),
	regulator_desc_lpm_ldo(12),
	regulator_desc_ldo(13),
	regulator_desc_lpm_ldo(14),
	regulator_desc_ldo_low(15),
	regulator_desc_lpm_ldo(16),
	regulator_desc_ldo(17),
	regulator_desc_ldo(18),
	regulator_desc_ldo(19),
	regulator_desc_ldo(20),
	regulator_desc_ldo(21),
	regulator_desc_ldo(22),
	regulator_desc_ldo(23),
	regulator_desc_ldo(24),
	regulator_desc_ldo(25),
	regulator_desc_ldo(26),
	regulator_desc_buck1(1),
	regulator_desc_buck_dvs(2),
	regulator_desc_buck_dvs(3),
	regulator_desc_buck_dvs(4),
	regulator_desc_buck(5),
	regulator_desc_buck(6),
	regulator_desc_buck(7),
	regulator_desc_buck(8),
	regulator_desc_buck(9),
};

#ifdef CONFIG_OF
static int max77686_pmic_dt_parse_pdata(struct platform_device *pdev,
					struct max77686_platform_data *pdata)
{
	struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
	struct device_node *pmic_np, *regulators_np;
	struct max77686_regulator_data *rdata;
	struct of_regulator_match rmatch;
	unsigned int i;

	pmic_np = iodev->dev->of_node;
	regulators_np = of_find_node_by_name(pmic_np, "voltage-regulators");
	if (!regulators_np) {
		dev_err(&pdev->dev, "could not find regulators sub-node\n");
		return -EINVAL;
	}

	pdata->num_regulators = ARRAY_SIZE(regulators);
	rdata = devm_kzalloc(&pdev->dev, sizeof(*rdata) *
			     pdata->num_regulators, GFP_KERNEL);
	if (!rdata) {
		dev_err(&pdev->dev,
			"could not allocate memory for regulator data\n");
		return -ENOMEM;
	}

	for (i = 0; i < pdata->num_regulators; i++) {
		rmatch.name = regulators[i].name;
		rmatch.init_data = NULL;
		rmatch.of_node = NULL;
		of_regulator_match(&pdev->dev, regulators_np, &rmatch, 1);
		rdata[i].initdata = rmatch.init_data;
		rdata[i].of_node = rmatch.of_node;
	}

	pdata->regulators = rdata;

	return 0;
}
#else
static int max77686_pmic_dt_parse_pdata(struct platform_device *pdev,
					struct max77686_platform_data *pdata)
{
	return 0;
}
#endif /* CONFIG_OF */

static int max77686_pmic_probe(struct platform_device *pdev)
{
	struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
	struct max77686_platform_data *pdata = dev_get_platdata(iodev->dev);
	struct max77686_data *max77686;
	int i, ret = 0;
	struct regulator_config config = { };

	dev_dbg(&pdev->dev, "%s\n", __func__);

	if (!pdata) {
		dev_err(&pdev->dev, "no platform data found for regulator\n");
		return -ENODEV;
	}

	if (iodev->dev->of_node) {
		ret = max77686_pmic_dt_parse_pdata(pdev, pdata);
		if (ret)
			return ret;
	}

	if (pdata->num_regulators != MAX77686_REGULATORS) {
		dev_err(&pdev->dev,
			"Invalid initial data for regulator's initialiation\n");
		return -EINVAL;
	}

	max77686 = devm_kzalloc(&pdev->dev, sizeof(struct max77686_data),
				GFP_KERNEL);
	if (!max77686)
		return -ENOMEM;

	config.dev = &pdev->dev;
	config.regmap = iodev->regmap;
	config.driver_data = max77686;
	platform_set_drvdata(pdev, max77686);

	for (i = 0; i < MAX77686_REGULATORS; i++) {
		config.init_data = pdata->regulators[i].initdata;
		config.of_node = pdata->regulators[i].of_node;

		max77686->opmode[i] = regulators[i].enable_mask;
		max77686->rdev[i] = regulator_register(&regulators[i], &config);
		if (IS_ERR(max77686->rdev[i])) {
			ret = PTR_ERR(max77686->rdev[i]);
			dev_err(&pdev->dev,
				"regulator init failed for %d\n", i);
			max77686->rdev[i] = NULL;
			goto err;
		}
	}

	return 0;
err:
	while (--i >= 0)
		regulator_unregister(max77686->rdev[i]);
	return ret;
}

static int max77686_pmic_remove(struct platform_device *pdev)
{
	struct max77686_data *max77686 = platform_get_drvdata(pdev);
	int i;

	for (i = 0; i < MAX77686_REGULATORS; i++)
		regulator_unregister(max77686->rdev[i]);

	return 0;
}

static const struct platform_device_id max77686_pmic_id[] = {
	{"max77686-pmic", 0},
	{ },
};
MODULE_DEVICE_TABLE(platform, max77686_pmic_id);

static struct platform_driver max77686_pmic_driver = {
	.driver = {
		.name = "max77686-pmic",
		.owner = THIS_MODULE,
	},
	.probe = max77686_pmic_probe,
	.remove = max77686_pmic_remove,
	.id_table = max77686_pmic_id,
};

static int __init max77686_pmic_init(void)
{
	return platform_driver_register(&max77686_pmic_driver);
}
subsys_initcall(max77686_pmic_init);

static void __exit max77686_pmic_cleanup(void)
{
	platform_driver_unregister(&max77686_pmic_driver);
}
module_exit(max77686_pmic_cleanup);

MODULE_DESCRIPTION("MAXIM 77686 Regulator Driver");
MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
133d4016 JL	1	/*
	2	* max77686.c - Regulator driver for the Maxim 77686
	3	*
	4	* Copyright (C) 2012 Samsung Electronics
	5	* Chiwoong Byun <woong.byun@smasung.com>
	6	* Jonghwa Lee <jonghwa3.lee@samsung.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	21	*
	22	* This driver is based on max8997.c
	23	*/
	24
	25	#include <linux/kernel.h>
	26	#include <linux/bug.h>
	27	#include <linux/delay.h>
	28	#include <linux/err.h>
	29	#include <linux/gpio.h>
	30	#include <linux/slab.h>
	31	#include <linux/platform_device.h>
	32	#include <linux/regulator/driver.h>
	33	#include <linux/regulator/machine.h>
4706fcab	34	#include <linux/regulator/of_regulator.h>
133d4016 JL	35	#include <linux/mfd/max77686.h>
	36	#include <linux/mfd/max77686-private.h>
	37
	38	#define MAX77686_LDO_MINUV 800000
	39	#define MAX77686_LDO_UVSTEP 50000
	40	#define MAX77686_LDO_LOW_MINUV 800000
	41	#define MAX77686_LDO_LOW_UVSTEP 25000
	42	#define MAX77686_BUCK_MINUV 750000
	43	#define MAX77686_BUCK_UVSTEP 50000
852abad2 YSB	44	#define MAX77686_RAMP_DELAY 100000 /* uV/us */
852abad2 YSB	45	#define MAX77686_DVS_RAMP_DELAY 27500 /* uV/us */
133d4016 JL	46	#define MAX77686_DVS_MINUV 600000
	47	#define MAX77686_DVS_UVSTEP 12500
	48
	49	#define MAX77686_OPMODE_SHIFT 6
	50	#define MAX77686_OPMODE_BUCK234_SHIFT 4
	51	#define MAX77686_OPMODE_MASK 0x3
	52
	53	#define MAX77686_VSEL_MASK 0x3F
	54	#define MAX77686_DVS_VSEL_MASK 0xFF
	55
	56	#define MAX77686_RAMP_RATE_MASK 0xC0
	57
	58	#define MAX77686_REGULATORS MAX77686_REG_MAX
	59	#define MAX77686_LDOS 26
	60
	61	enum max77686_ramp_rate {
	62	RAMP_RATE_13P75MV,
	63	RAMP_RATE_27P5MV,
	64	RAMP_RATE_55MV,
	65	RAMP_RATE_NO_CTRL, /* 100mV/us */
	66	};
	67
	68	struct max77686_data {
cb44cdea	69	struct regulator_dev *rdev[MAX77686_REGULATORS];
6d2c896b	70	unsigned int opmode[MAX77686_REGULATORS];
133d4016 JL	71	};
133d4016 JL	72
15282ba9 YSB	73	/* Some BUCKS supports Normal[ON/OFF] mode during suspend */
	74	static int max77686_buck_set_suspend_disable(struct regulator_dev *rdev)
	75	{
	76	unsigned int val;
	77	struct max77686_data *max77686 = rdev_get_drvdata(rdev);
40e72149	78	int id = rdev_get_id(rdev);
15282ba9	79
40e72149	80	if (id == MAX77686_BUCK1)
15282ba9 YSB	81	val = 0x1;
	82	else
	83	val = 0x1 << MAX77686_OPMODE_BUCK234_SHIFT;
	84
40e72149	85	max77686->opmode[id] = val;
15282ba9 YSB	86	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
	87	rdev->desc->enable_mask,
	88	val);
	89	}
	90
	91	/* Some LDOs supports [LPM/Normal]ON mode during suspend state */
	92	static int max77686_set_suspend_mode(struct regulator_dev *rdev,
	93	unsigned int mode)
	94	{
	95	struct max77686_data *max77686 = rdev_get_drvdata(rdev);
	96	unsigned int val;
40e72149	97	int id = rdev_get_id(rdev);
15282ba9 YSB	98
15282ba9 YSB	99	/* BUCK[5-9] doesn't support this feature */
40e72149	100	if (id >= MAX77686_BUCK5)
15282ba9 YSB	101	return 0;
	102
	103	switch (mode) {
	104	case REGULATOR_MODE_IDLE: /* ON in LP Mode */
	105	val = 0x2 << MAX77686_OPMODE_SHIFT;
	106	break;
	107	case REGULATOR_MODE_NORMAL: /* ON in Normal Mode */
	108	val = 0x3 << MAX77686_OPMODE_SHIFT;
	109	break;
	110	default:
	111	pr_warn("%s: regulator_suspend_mode : 0x%x not supported\n",
	112	rdev->desc->name, mode);
	113	return -EINVAL;
	114	}
	115
40e72149	116	max77686->opmode[id] = val;
15282ba9 YSB	117	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
	118	rdev->desc->enable_mask,
	119	val);
	120	}
	121
	122	/* Some LDOs supports LPM-ON/OFF/Normal-ON mode during suspend state */
	123	static int max77686_ldo_set_suspend_mode(struct regulator_dev *rdev,
	124	unsigned int mode)
	125	{
	126	unsigned int val;
	127	struct max77686_data *max77686 = rdev_get_drvdata(rdev);
	128
	129	switch (mode) {
	130	case REGULATOR_MODE_STANDBY: /* switch off */
	131	val = 0x1 << MAX77686_OPMODE_SHIFT;
	132	break;
	133	case REGULATOR_MODE_IDLE: /* ON in LP Mode */
	134	val = 0x2 << MAX77686_OPMODE_SHIFT;
	135	break;
	136	case REGULATOR_MODE_NORMAL: /* ON in Normal Mode */
	137	val = 0x3 << MAX77686_OPMODE_SHIFT;
	138	break;
	139	default:
	140	pr_warn("%s: regulator_suspend_mode : 0x%x not supported\n",
	141	rdev->desc->name, mode);
	142	return -EINVAL;
	143	}
	144
40e72149	145	max77686->opmode[rdev_get_id(rdev)] = val;
15282ba9 YSB	146	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
	147	rdev->desc->enable_mask,
	148	val);
	149	}
	150
38d34035	151	static int max77686_enable(struct regulator_dev *rdev)
6d2c896b YSB	152	{
	153	struct max77686_data *max77686 = rdev_get_drvdata(rdev);
	154
	155	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
	156	rdev->desc->enable_mask,
40e72149	157	max77686->opmode[rdev_get_id(rdev)]);
6d2c896b YSB	158	}
6d2c896b YSB	159
f503071b YSB	160	static int max77686_set_ramp_delay(struct regulator_dev *rdev, int ramp_delay)
	161	{
	162	unsigned int ramp_value = RAMP_RATE_NO_CTRL;
	163
	164	switch (ramp_delay) {
	165	case 1 ... 13750:
	166	ramp_value = RAMP_RATE_13P75MV;
	167	break;
	168	case 13751 ... 27500:
	169	ramp_value = RAMP_RATE_27P5MV;
	170	break;
	171	case 27501 ... 55000:
	172	ramp_value = RAMP_RATE_55MV;
	173	break;
	174	case 55001 ... 100000:
	175	break;
	176	default:
	177	pr_warn("%s: ramp_delay: %d not supported, setting 100000\n",
	178	rdev->desc->name, ramp_delay);
	179	}
	180
	181	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
	182	MAX77686_RAMP_RATE_MASK, ramp_value << 6);
	183	}
	184
133d4016 JL	185	static struct regulator_ops max77686_ops = {
133d4016 JL	186	.list_voltage = regulator_list_voltage_linear,
2e3f7f26	187	.map_voltage = regulator_map_voltage_linear,
133d4016	188	.is_enabled = regulator_is_enabled_regmap,
6d2c896b	189	.enable = max77686_enable,
133d4016 JL	190	.disable = regulator_disable_regmap,
	191	.get_voltage_sel = regulator_get_voltage_sel_regmap,
	192	.set_voltage_sel = regulator_set_voltage_sel_regmap,
852abad2	193	.set_voltage_time_sel = regulator_set_voltage_time_sel,
15282ba9 YSB	194	.set_suspend_mode = max77686_set_suspend_mode,
	195	};
	196
	197	static struct regulator_ops max77686_ldo_ops = {
	198	.list_voltage = regulator_list_voltage_linear,
	199	.map_voltage = regulator_map_voltage_linear,
	200	.is_enabled = regulator_is_enabled_regmap,
	201	.enable = max77686_enable,
133d4016 JL	202	.disable = regulator_disable_regmap,
	203	.get_voltage_sel = regulator_get_voltage_sel_regmap,
	204	.set_voltage_sel = regulator_set_voltage_sel_regmap,
852abad2	205	.set_voltage_time_sel = regulator_set_voltage_time_sel,
15282ba9 YSB	206	.set_suspend_mode = max77686_ldo_set_suspend_mode,
	207	};
	208
	209	static struct regulator_ops max77686_buck1_ops = {
	210	.list_voltage = regulator_list_voltage_linear,
	211	.map_voltage = regulator_map_voltage_linear,
	212	.is_enabled = regulator_is_enabled_regmap,
	213	.enable = max77686_enable,
	214	.disable = regulator_disable_regmap,
	215	.get_voltage_sel = regulator_get_voltage_sel_regmap,
	216	.set_voltage_sel = regulator_set_voltage_sel_regmap,
	217	.set_voltage_time_sel = regulator_set_voltage_time_sel,
	218	.set_suspend_disable = max77686_buck_set_suspend_disable,
133d4016 JL	219	};
	220
	221	static struct regulator_ops max77686_buck_dvs_ops = {
	222	.list_voltage = regulator_list_voltage_linear,
2e3f7f26	223	.map_voltage = regulator_map_voltage_linear,
133d4016	224	.is_enabled = regulator_is_enabled_regmap,
6d2c896b	225	.enable = max77686_enable,
133d4016 JL	226	.disable = regulator_disable_regmap,
	227	.get_voltage_sel = regulator_get_voltage_sel_regmap,
	228	.set_voltage_sel = regulator_set_voltage_sel_regmap,
852abad2	229	.set_voltage_time_sel = regulator_set_voltage_time_sel,
f503071b	230	.set_ramp_delay = max77686_set_ramp_delay,
15282ba9	231	.set_suspend_disable = max77686_buck_set_suspend_disable,
133d4016 JL	232	};
	233
	234	#define regulator_desc_ldo(num) { \
	235	.name = "LDO"#num, \
	236	.id = MAX77686_LDO##num, \
	237	.ops = &max77686_ops, \
	238	.type = REGULATOR_VOLTAGE, \
	239	.owner = THIS_MODULE, \
	240	.min_uV = MAX77686_LDO_MINUV, \
	241	.uV_step = MAX77686_LDO_UVSTEP, \
852abad2	242	.ramp_delay = MAX77686_RAMP_DELAY, \
133d4016 JL	243	.n_voltages = MAX77686_VSEL_MASK + 1, \
	244	.vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
	245	.vsel_mask = MAX77686_VSEL_MASK, \
	246	.enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
	247	.enable_mask = MAX77686_OPMODE_MASK \
	248	<< MAX77686_OPMODE_SHIFT, \
	249	}
15282ba9 YSB	250	#define regulator_desc_lpm_ldo(num) { \
	251	.name = "LDO"#num, \
	252	.id = MAX77686_LDO##num, \
	253	.ops = &max77686_ldo_ops, \
	254	.type = REGULATOR_VOLTAGE, \
	255	.owner = THIS_MODULE, \
	256	.min_uV = MAX77686_LDO_MINUV, \
	257	.uV_step = MAX77686_LDO_UVSTEP, \
	258	.ramp_delay = MAX77686_RAMP_DELAY, \
	259	.n_voltages = MAX77686_VSEL_MASK + 1, \
	260	.vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
	261	.vsel_mask = MAX77686_VSEL_MASK, \
	262	.enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
	263	.enable_mask = MAX77686_OPMODE_MASK \
	264	<< MAX77686_OPMODE_SHIFT, \
	265	}
133d4016	266	#define regulator_desc_ldo_low(num) { \
15282ba9 YSB	267	.name = "LDO"#num, \
	268	.id = MAX77686_LDO##num, \
	269	.ops = &max77686_ldo_ops, \
	270	.type = REGULATOR_VOLTAGE, \
	271	.owner = THIS_MODULE, \
	272	.min_uV = MAX77686_LDO_LOW_MINUV, \
	273	.uV_step = MAX77686_LDO_LOW_UVSTEP, \
	274	.ramp_delay = MAX77686_RAMP_DELAY, \
	275	.n_voltages = MAX77686_VSEL_MASK + 1, \
	276	.vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
	277	.vsel_mask = MAX77686_VSEL_MASK, \
	278	.enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
	279	.enable_mask = MAX77686_OPMODE_MASK \
	280	<< MAX77686_OPMODE_SHIFT, \
	281	}
	282	#define regulator_desc_ldo1_low(num) { \
133d4016 JL	283	.name = "LDO"#num, \
	284	.id = MAX77686_LDO##num, \
	285	.ops = &max77686_ops, \
	286	.type = REGULATOR_VOLTAGE, \
	287	.owner = THIS_MODULE, \
	288	.min_uV = MAX77686_LDO_LOW_MINUV, \
	289	.uV_step = MAX77686_LDO_LOW_UVSTEP, \
852abad2	290	.ramp_delay = MAX77686_RAMP_DELAY, \
133d4016 JL	291	.n_voltages = MAX77686_VSEL_MASK + 1, \
	292	.vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
	293	.vsel_mask = MAX77686_VSEL_MASK, \
	294	.enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
	295	.enable_mask = MAX77686_OPMODE_MASK \
	296	<< MAX77686_OPMODE_SHIFT, \
	297	}
	298	#define regulator_desc_buck(num) { \
	299	.name = "BUCK"#num, \
	300	.id = MAX77686_BUCK##num, \
	301	.ops = &max77686_ops, \
	302	.type = REGULATOR_VOLTAGE, \
	303	.owner = THIS_MODULE, \
	304	.min_uV = MAX77686_BUCK_MINUV, \
	305	.uV_step = MAX77686_BUCK_UVSTEP, \
852abad2	306	.ramp_delay = MAX77686_RAMP_DELAY, \
133d4016 JL	307	.n_voltages = MAX77686_VSEL_MASK + 1, \
	308	.vsel_reg = MAX77686_REG_BUCK5OUT + (num - 5) * 2, \
	309	.vsel_mask = MAX77686_VSEL_MASK, \
	310	.enable_reg = MAX77686_REG_BUCK5CTRL + (num - 5) * 2, \
	311	.enable_mask = MAX77686_OPMODE_MASK, \
	312	}
	313	#define regulator_desc_buck1(num) { \
	314	.name = "BUCK"#num, \
	315	.id = MAX77686_BUCK##num, \
15282ba9	316	.ops = &max77686_buck1_ops, \
133d4016 JL	317	.type = REGULATOR_VOLTAGE, \
	318	.owner = THIS_MODULE, \
	319	.min_uV = MAX77686_BUCK_MINUV, \
	320	.uV_step = MAX77686_BUCK_UVSTEP, \
852abad2	321	.ramp_delay = MAX77686_RAMP_DELAY, \
133d4016 JL	322	.n_voltages = MAX77686_VSEL_MASK + 1, \
	323	.vsel_reg = MAX77686_REG_BUCK1OUT, \
	324	.vsel_mask = MAX77686_VSEL_MASK, \
	325	.enable_reg = MAX77686_REG_BUCK1CTRL, \
	326	.enable_mask = MAX77686_OPMODE_MASK, \
	327	}
	328	#define regulator_desc_buck_dvs(num) { \
	329	.name = "BUCK"#num, \
	330	.id = MAX77686_BUCK##num, \
74adfee5	331	.ops = &max77686_buck_dvs_ops, \
133d4016 JL	332	.type = REGULATOR_VOLTAGE, \
	333	.owner = THIS_MODULE, \
	334	.min_uV = MAX77686_DVS_MINUV, \
	335	.uV_step = MAX77686_DVS_UVSTEP, \
852abad2	336	.ramp_delay = MAX77686_DVS_RAMP_DELAY, \
133d4016 JL	337	.n_voltages = MAX77686_DVS_VSEL_MASK + 1, \
	338	.vsel_reg = MAX77686_REG_BUCK2DVS1 + (num - 2) * 10, \
	339	.vsel_mask = MAX77686_DVS_VSEL_MASK, \
	340	.enable_reg = MAX77686_REG_BUCK2CTRL1 + (num - 2) * 10, \
	341	.enable_mask = MAX77686_OPMODE_MASK \
	342	<< MAX77686_OPMODE_BUCK234_SHIFT, \
	343	}
	344
	345	static struct regulator_desc regulators[] = {
15282ba9	346	regulator_desc_ldo1_low(1),
133d4016 JL	347	regulator_desc_ldo_low(2),
	348	regulator_desc_ldo(3),
	349	regulator_desc_ldo(4),
	350	regulator_desc_ldo(5),
	351	regulator_desc_ldo_low(6),
	352	regulator_desc_ldo_low(7),
	353	regulator_desc_ldo_low(8),
	354	regulator_desc_ldo(9),
15282ba9 YSB	355	regulator_desc_lpm_ldo(10),
	356	regulator_desc_lpm_ldo(11),
	357	regulator_desc_lpm_ldo(12),
133d4016	358	regulator_desc_ldo(13),
15282ba9	359	regulator_desc_lpm_ldo(14),
133d4016	360	regulator_desc_ldo_low(15),
15282ba9	361	regulator_desc_lpm_ldo(16),
133d4016 JL	362	regulator_desc_ldo(17),
	363	regulator_desc_ldo(18),
	364	regulator_desc_ldo(19),
	365	regulator_desc_ldo(20),
	366	regulator_desc_ldo(21),
	367	regulator_desc_ldo(22),
	368	regulator_desc_ldo(23),
	369	regulator_desc_ldo(24),
	370	regulator_desc_ldo(25),
	371	regulator_desc_ldo(26),
	372	regulator_desc_buck1(1),
	373	regulator_desc_buck_dvs(2),
	374	regulator_desc_buck_dvs(3),
	375	regulator_desc_buck_dvs(4),
	376	regulator_desc_buck(5),
	377	regulator_desc_buck(6),
	378	regulator_desc_buck(7),
	379	regulator_desc_buck(8),
	380	regulator_desc_buck(9),
	381	};
	382
4706fcab	383	#ifdef CONFIG_OF
b19f5758	384	static int max77686_pmic_dt_parse_pdata(struct platform_device *pdev,
4706fcab YSB	385	struct max77686_platform_data *pdata)
4706fcab YSB	386	{
b19f5758	387	struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
4706fcab YSB	388	struct device_node pmic_np, regulators_np;
	389	struct max77686_regulator_data *rdata;
	390	struct of_regulator_match rmatch;
	391	unsigned int i;
	392
	393	pmic_np = iodev->dev->of_node;
	394	regulators_np = of_find_node_by_name(pmic_np, "voltage-regulators");
	395	if (!regulators_np) {
b19f5758	396	dev_err(&pdev->dev, "could not find regulators sub-node\n");
4706fcab YSB	397	return -EINVAL;
	398	}
	399
	400	pdata->num_regulators = ARRAY_SIZE(regulators);
b19f5758	401	rdata = devm_kzalloc(&pdev->dev, sizeof(rdata)
4706fcab YSB	402	pdata->num_regulators, GFP_KERNEL);
4706fcab YSB	403	if (!rdata) {
b19f5758	404	dev_err(&pdev->dev,
4706fcab YSB	405	"could not allocate memory for regulator data\n");
	406	return -ENOMEM;
	407	}
	408
	409	for (i = 0; i < pdata->num_regulators; i++) {
	410	rmatch.name = regulators[i].name;
	411	rmatch.init_data = NULL;
d1ef065d	412	rmatch.of_node = NULL;
b19f5758	413	of_regulator_match(&pdev->dev, regulators_np, &rmatch, 1);
4706fcab	414	rdata[i].initdata = rmatch.init_data;
2c58e266	415	rdata[i].of_node = rmatch.of_node;
4706fcab YSB	416	}
	417
	418	pdata->regulators = rdata;
	419
	420	return 0;
	421	}
	422	#else
b19f5758	423	static int max77686_pmic_dt_parse_pdata(struct platform_device *pdev,
4706fcab YSB	424	struct max77686_platform_data *pdata)
	425	{
	426	return 0;
	427	}
	428	#endif /* CONFIG_OF */
	429
a5023574	430	static int max77686_pmic_probe(struct platform_device *pdev)
133d4016 JL	431	{
	432	struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
	433	struct max77686_platform_data *pdata = dev_get_platdata(iodev->dev);
133d4016	434	struct max77686_data *max77686;
cb44cdea	435	int i, ret = 0;
c59d2a6b	436	struct regulator_config config = { };
133d4016 JL	437
	438	dev_dbg(&pdev->dev, "%s\n", __func__);
	439
4706fcab YSB	440	if (!pdata) {
	441	dev_err(&pdev->dev, "no platform data found for regulator\n");
	442	return -ENODEV;
	443	}
	444
	445	if (iodev->dev->of_node) {
b19f5758	446	ret = max77686_pmic_dt_parse_pdata(pdev, pdata);
4706fcab YSB	447	if (ret)
	448	return ret;
	449	}
	450
	451	if (pdata->num_regulators != MAX77686_REGULATORS) {
ab0d1cbe AL	452	dev_err(&pdev->dev,
	453	"Invalid initial data for regulator's initialiation\n");
	454	return -EINVAL;
	455	}
	456
133d4016 JL	457	max77686 = devm_kzalloc(&pdev->dev, sizeof(struct max77686_data),
	458	GFP_KERNEL);
	459	if (!max77686)
	460	return -ENOMEM;
	461
f503071b YSB	462	config.dev = &pdev->dev;
f503071b YSB	463	config.regmap = iodev->regmap;
6d2c896b	464	config.driver_data = max77686;
133d4016 JL	465	platform_set_drvdata(pdev, max77686);
133d4016 JL	466
ab0d1cbe	467	for (i = 0; i < MAX77686_REGULATORS; i++) {
ab0d1cbe	468	config.init_data = pdata->regulators[i].initdata;
2c58e266	469	config.of_node = pdata->regulators[i].of_node;
133d4016	470
6d2c896b	471	max77686->opmode[i] = regulators[i].enable_mask;
cb44cdea AL	472	max77686->rdev[i] = regulator_register(&regulators[i], &config);
	473	if (IS_ERR(max77686->rdev[i])) {
	474	ret = PTR_ERR(max77686->rdev[i]);
f503071b	475	dev_err(&pdev->dev,
133d4016	476	"regulator init failed for %d\n", i);
cb44cdea AL	477	max77686->rdev[i] = NULL;
cb44cdea AL	478	goto err;
133d4016	479	}
133d4016	480	}
ab0d1cbe	481
133d4016 JL	482	return 0;
133d4016 JL	483	err:
ab0d1cbe	484	while (--i >= 0)
cb44cdea	485	regulator_unregister(max77686->rdev[i]);
133d4016 JL	486	return ret;
	487	}
	488
8dc995f5	489	static int max77686_pmic_remove(struct platform_device *pdev)
133d4016 JL	490	{
133d4016 JL	491	struct max77686_data *max77686 = platform_get_drvdata(pdev);
133d4016 JL	492	int i;
	493
	494	for (i = 0; i < MAX77686_REGULATORS; i++)
cb44cdea	495	regulator_unregister(max77686->rdev[i]);
133d4016 JL	496
	497	return 0;
	498	}
	499
	500	static const struct platform_device_id max77686_pmic_id[] = {
	501	{"max77686-pmic", 0},
	502	{ },
	503	};
	504	MODULE_DEVICE_TABLE(platform, max77686_pmic_id);
	505
	506	static struct platform_driver max77686_pmic_driver = {
	507	.driver = {
	508	.name = "max77686-pmic",
	509	.owner = THIS_MODULE,
	510	},
	511	.probe = max77686_pmic_probe,
5eb9f2b9	512	.remove = max77686_pmic_remove,
133d4016 JL	513	.id_table = max77686_pmic_id,
	514	};
	515
	516	static int __init max77686_pmic_init(void)
	517	{
	518	return platform_driver_register(&max77686_pmic_driver);
	519	}
	520	subsys_initcall(max77686_pmic_init);
	521
	522	static void __exit max77686_pmic_cleanup(void)
	523	{
	524	platform_driver_unregister(&max77686_pmic_driver);
	525	}
	526	module_exit(max77686_pmic_cleanup);
	527
	528	MODULE_DESCRIPTION("MAXIM 77686 Regulator Driver");
	529	MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
	530	MODULE_LICENSE("GPL");