[linux-2.6-block.git] / drivers / regulator / max8649.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Regulators driver for Maxim max8649
 *
 * Copyright (C) 2009-2010 Marvell International Ltd.
 *      Haojian Zhuang <haojian.zhuang@marvell.com>
 */
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/err.h>
#include <linux/i2c.h>
#include <linux/platform_device.h>
#include <linux/regulator/driver.h>
#include <linux/slab.h>
#include <linux/regulator/max8649.h>
#include <linux/regmap.h>

#define MAX8649_DCDC_VMIN	750000		/* uV */
#define MAX8649_DCDC_VMAX	1380000		/* uV */
#define MAX8649_DCDC_STEP	10000		/* uV */
#define MAX8649_VOL_MASK	0x3f

/* Registers */
#define MAX8649_MODE0		0x00
#define MAX8649_MODE1		0x01
#define MAX8649_MODE2		0x02
#define MAX8649_MODE3		0x03
#define MAX8649_CONTROL		0x04
#define MAX8649_SYNC		0x05
#define MAX8649_RAMP		0x06
#define MAX8649_CHIP_ID1	0x08
#define MAX8649_CHIP_ID2	0x09

/* Bits */
#define MAX8649_EN_PD		(1 << 7)
#define MAX8649_VID0_PD		(1 << 6)
#define MAX8649_VID1_PD		(1 << 5)
#define MAX8649_VID_MASK	(3 << 5)

#define MAX8649_FORCE_PWM	(1 << 7)
#define MAX8649_SYNC_EXTCLK	(1 << 6)

#define MAX8649_EXT_MASK	(3 << 6)

#define MAX8649_RAMP_MASK	(7 << 5)
#define MAX8649_RAMP_DOWN	(1 << 1)

struct max8649_regulator_info {
	struct device		*dev;
	struct regmap		*regmap;

	unsigned	mode:2;	/* bit[1:0] = VID1, VID0 */
	unsigned	extclk_freq:2;
	unsigned	extclk:1;
	unsigned	ramp_timing:3;
	unsigned	ramp_down:1;
};

static int max8649_enable_time(struct regulator_dev *rdev)
{
	struct max8649_regulator_info *info = rdev_get_drvdata(rdev);
	int voltage, rate, ret;
	unsigned int val;

	/* get voltage */
	ret = regmap_read(info->regmap, rdev->desc->vsel_reg, &val);
	if (ret != 0)
		return ret;
	val &= MAX8649_VOL_MASK;
	voltage = regulator_list_voltage_linear(rdev, (unsigned char)val);

	/* get rate */
	ret = regmap_read(info->regmap, MAX8649_RAMP, &val);
	if (ret != 0)
		return ret;
	ret = (val & MAX8649_RAMP_MASK) >> 5;
	rate = (32 * 1000) >> ret;	/* uV/uS */

	return DIV_ROUND_UP(voltage, rate);
}

static int max8649_set_mode(struct regulator_dev *rdev, unsigned int mode)
{
	struct max8649_regulator_info *info = rdev_get_drvdata(rdev);

	switch (mode) {
	case REGULATOR_MODE_FAST:
		regmap_update_bits(info->regmap, rdev->desc->vsel_reg,
				   MAX8649_FORCE_PWM, MAX8649_FORCE_PWM);
		break;
	case REGULATOR_MODE_NORMAL:
		regmap_update_bits(info->regmap, rdev->desc->vsel_reg,
				   MAX8649_FORCE_PWM, 0);
		break;
	default:
		return -EINVAL;
	}
	return 0;
}

static unsigned int max8649_get_mode(struct regulator_dev *rdev)
{
	struct max8649_regulator_info *info = rdev_get_drvdata(rdev);
	unsigned int val;
	int ret;

	ret = regmap_read(info->regmap, rdev->desc->vsel_reg, &val);
	if (ret != 0)
		return ret;
	if (val & MAX8649_FORCE_PWM)
		return REGULATOR_MODE_FAST;
	return REGULATOR_MODE_NORMAL;
}

static const struct regulator_ops max8649_dcdc_ops = {
	.set_voltage_sel = regulator_set_voltage_sel_regmap,
	.get_voltage_sel = regulator_get_voltage_sel_regmap,
	.list_voltage	= regulator_list_voltage_linear,
	.map_voltage	= regulator_map_voltage_linear,
	.enable		= regulator_enable_regmap,
	.disable	= regulator_disable_regmap,
	.is_enabled	= regulator_is_enabled_regmap,
	.enable_time	= max8649_enable_time,
	.set_mode	= max8649_set_mode,
	.get_mode	= max8649_get_mode,

};

static struct regulator_desc dcdc_desc = {
	.name		= "max8649",
	.ops		= &max8649_dcdc_ops,
	.type		= REGULATOR_VOLTAGE,
	.n_voltages	= 1 << 6,
	.owner		= THIS_MODULE,
	.vsel_mask	= MAX8649_VOL_MASK,
	.min_uV		= MAX8649_DCDC_VMIN,
	.uV_step	= MAX8649_DCDC_STEP,
	.enable_reg	= MAX8649_CONTROL,
	.enable_mask	= MAX8649_EN_PD,
	.enable_is_inverted = true,
};

static const struct regmap_config max8649_regmap_config = {
	.reg_bits = 8,
	.val_bits = 8,
};

static int max8649_regulator_probe(struct i2c_client *client,
					     const struct i2c_device_id *id)
{
	struct max8649_platform_data *pdata = dev_get_platdata(&client->dev);
	struct max8649_regulator_info *info = NULL;
	struct regulator_dev *regulator;
	struct regulator_config config = { };
	unsigned int val;
	unsigned char data;
	int ret;

	info = devm_kzalloc(&client->dev, sizeof(struct max8649_regulator_info),
			    GFP_KERNEL);
	if (!info)
		return -ENOMEM;

	info->regmap = devm_regmap_init_i2c(client, &max8649_regmap_config);
	if (IS_ERR(info->regmap)) {
		ret = PTR_ERR(info->regmap);
		dev_err(&client->dev, "Failed to allocate register map: %d\n", ret);
		return ret;
	}

	info->dev = &client->dev;
	i2c_set_clientdata(client, info);

	info->mode = pdata->mode;
	switch (info->mode) {
	case 0:
		dcdc_desc.vsel_reg = MAX8649_MODE0;
		break;
	case 1:
		dcdc_desc.vsel_reg = MAX8649_MODE1;
		break;
	case 2:
		dcdc_desc.vsel_reg = MAX8649_MODE2;
		break;
	case 3:
		dcdc_desc.vsel_reg = MAX8649_MODE3;
		break;
	default:
		break;
	}

	ret = regmap_read(info->regmap, MAX8649_CHIP_ID1, &val);
	if (ret != 0) {
		dev_err(info->dev, "Failed to detect ID of MAX8649:%d\n",
			ret);
		return ret;
	}
	dev_info(info->dev, "Detected MAX8649 (ID:%x)\n", val);

	/* enable VID0 & VID1 */
	regmap_update_bits(info->regmap, MAX8649_CONTROL, MAX8649_VID_MASK, 0);

	/* enable/disable external clock synchronization */
	info->extclk = pdata->extclk;
	data = (info->extclk) ? MAX8649_SYNC_EXTCLK : 0;
	regmap_update_bits(info->regmap, dcdc_desc.vsel_reg,
			   MAX8649_SYNC_EXTCLK, data);
	if (info->extclk) {
		/* set external clock frequency */
		info->extclk_freq = pdata->extclk_freq;
		regmap_update_bits(info->regmap, MAX8649_SYNC, MAX8649_EXT_MASK,
				   info->extclk_freq << 6);
	}

	if (pdata->ramp_timing) {
		info->ramp_timing = pdata->ramp_timing;
		regmap_update_bits(info->regmap, MAX8649_RAMP, MAX8649_RAMP_MASK,
				   info->ramp_timing << 5);
	}

	info->ramp_down = pdata->ramp_down;
	if (info->ramp_down) {
		regmap_update_bits(info->regmap, MAX8649_RAMP, MAX8649_RAMP_DOWN,
				   MAX8649_RAMP_DOWN);
	}

	config.dev = &client->dev;
	config.init_data = pdata->regulator;
	config.driver_data = info;
	config.regmap = info->regmap;

	regulator = devm_regulator_register(&client->dev, &dcdc_desc,
						  &config);
	if (IS_ERR(regulator)) {
		dev_err(info->dev, "failed to register regulator %s\n",
			dcdc_desc.name);
		return PTR_ERR(regulator);
	}

	return 0;
}

static const struct i2c_device_id max8649_id[] = {
	{ "max8649", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, max8649_id);

static struct i2c_driver max8649_driver = {
	.probe		= max8649_regulator_probe,
	.driver		= {
		.name	= "max8649",
	},
	.id_table	= max8649_id,
};

static int __init max8649_init(void)
{
	return i2c_add_driver(&max8649_driver);
}
subsys_initcall(max8649_init);

static void __exit max8649_exit(void)
{
	i2c_del_driver(&max8649_driver);
}
module_exit(max8649_exit);

/* Module information */
MODULE_DESCRIPTION("MAXIM 8649 voltage regulator driver");
MODULE_AUTHOR("Haojian Zhuang <haojian.zhuang@marvell.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
a71b797f HZ	2	/*
	3	* Regulators driver for Maxim max8649
	4	*
	5	* Copyright (C) 2009-2010 Marvell International Ltd.
	6	* Haojian Zhuang <haojian.zhuang@marvell.com>
a71b797f HZ	7	*/
	8	#include <linux/kernel.h>
	9	#include <linux/module.h>
	10	#include <linux/err.h>
	11	#include <linux/i2c.h>
	12	#include <linux/platform_device.h>
	13	#include <linux/regulator/driver.h>
5a0e3ad6	14	#include <linux/slab.h>
a71b797f	15	#include <linux/regulator/max8649.h>
c5b68d47	16	#include <linux/regmap.h>
a71b797f HZ	17
	18	#define MAX8649_DCDC_VMIN 750000 /* uV */
	19	#define MAX8649_DCDC_VMAX 1380000 /* uV */
	20	#define MAX8649_DCDC_STEP 10000 /* uV */
	21	#define MAX8649_VOL_MASK 0x3f
	22
	23	/* Registers */
	24	#define MAX8649_MODE0 0x00
	25	#define MAX8649_MODE1 0x01
	26	#define MAX8649_MODE2 0x02
	27	#define MAX8649_MODE3 0x03
	28	#define MAX8649_CONTROL 0x04
	29	#define MAX8649_SYNC 0x05
	30	#define MAX8649_RAMP 0x06
	31	#define MAX8649_CHIP_ID1 0x08
	32	#define MAX8649_CHIP_ID2 0x09
	33
	34	/* Bits */
	35	#define MAX8649_EN_PD (1 << 7)
	36	#define MAX8649_VID0_PD (1 << 6)
	37	#define MAX8649_VID1_PD (1 << 5)
	38	#define MAX8649_VID_MASK (3 << 5)
	39
	40	#define MAX8649_FORCE_PWM (1 << 7)
	41	#define MAX8649_SYNC_EXTCLK (1 << 6)
	42
	43	#define MAX8649_EXT_MASK (3 << 6)
	44
	45	#define MAX8649_RAMP_MASK (7 << 5)
	46	#define MAX8649_RAMP_DOWN (1 << 1)
	47
	48	struct max8649_regulator_info {
a71b797f	49	struct device *dev;
c5b68d47	50	struct regmap *regmap;
a71b797f	51
a71b797f HZ	52	unsigned mode:2; /* bit[1:0] = VID1, VID0 */
	53	unsigned extclk_freq:2;
	54	unsigned extclk:1;
	55	unsigned ramp_timing:3;
	56	unsigned ramp_down:1;
	57	};
	58
a71b797f HZ	59	static int max8649_enable_time(struct regulator_dev *rdev)
	60	{
	61	struct max8649_regulator_info *info = rdev_get_drvdata(rdev);
	62	int voltage, rate, ret;
c5b68d47	63	unsigned int val;
a71b797f HZ	64
a71b797f HZ	65	/* get voltage */
817d8c2d	66	ret = regmap_read(info->regmap, rdev->desc->vsel_reg, &val);
c5b68d47	67	if (ret != 0)
a71b797f	68	return ret;
c5b68d47	69	val &= MAX8649_VOL_MASK;
0fb737b5	70	voltage = regulator_list_voltage_linear(rdev, (unsigned char)val);
a71b797f HZ	71
a71b797f HZ	72	/* get rate */
c5b68d47 JC	73	ret = regmap_read(info->regmap, MAX8649_RAMP, &val);
c5b68d47 JC	74	if (ret != 0)
a71b797f	75	return ret;
c5b68d47	76	ret = (val & MAX8649_RAMP_MASK) >> 5;
a71b797f HZ	77	rate = (32 * 1000) >> ret; /* uV/uS */
a71b797f HZ	78
e69c4997	79	return DIV_ROUND_UP(voltage, rate);
a71b797f HZ	80	}
	81
	82	static int max8649_set_mode(struct regulator_dev *rdev, unsigned int mode)
	83	{
	84	struct max8649_regulator_info *info = rdev_get_drvdata(rdev);
	85
	86	switch (mode) {
	87	case REGULATOR_MODE_FAST:
817d8c2d AL	88	regmap_update_bits(info->regmap, rdev->desc->vsel_reg,
817d8c2d AL	89	MAX8649_FORCE_PWM, MAX8649_FORCE_PWM);
a71b797f HZ	90	break;
a71b797f HZ	91	case REGULATOR_MODE_NORMAL:
817d8c2d	92	regmap_update_bits(info->regmap, rdev->desc->vsel_reg,
c5b68d47	93	MAX8649_FORCE_PWM, 0);
a71b797f HZ	94	break;
	95	default:
	96	return -EINVAL;
	97	}
	98	return 0;
	99	}
	100
	101	static unsigned int max8649_get_mode(struct regulator_dev *rdev)
	102	{
	103	struct max8649_regulator_info *info = rdev_get_drvdata(rdev);
c5b68d47	104	unsigned int val;
a71b797f HZ	105	int ret;
a71b797f HZ	106
817d8c2d	107	ret = regmap_read(info->regmap, rdev->desc->vsel_reg, &val);
c5b68d47 JC	108	if (ret != 0)
	109	return ret;
	110	if (val & MAX8649_FORCE_PWM)
a71b797f HZ	111	return REGULATOR_MODE_FAST;
	112	return REGULATOR_MODE_NORMAL;
	113	}
	114
035f3324	115	static const struct regulator_ops max8649_dcdc_ops = {
40baecee	116	.set_voltage_sel = regulator_set_voltage_sel_regmap,
817d8c2d	117	.get_voltage_sel = regulator_get_voltage_sel_regmap,
0fb737b5	118	.list_voltage = regulator_list_voltage_linear,
40baecee	119	.map_voltage = regulator_map_voltage_linear,
ea88b132 AL	120	.enable = regulator_enable_regmap,
	121	.disable = regulator_disable_regmap,
	122	.is_enabled = regulator_is_enabled_regmap,
a71b797f HZ	123	.enable_time = max8649_enable_time,
	124	.set_mode = max8649_set_mode,
	125	.get_mode = max8649_get_mode,
	126
	127	};
	128
817d8c2d	129	static struct regulator_desc dcdc_desc = {
a71b797f HZ	130	.name = "max8649",
	131	.ops = &max8649_dcdc_ops,
	132	.type = REGULATOR_VOLTAGE,
	133	.n_voltages = 1 << 6,
	134	.owner = THIS_MODULE,
817d8c2d	135	.vsel_mask = MAX8649_VOL_MASK,
0fb737b5 AL	136	.min_uV = MAX8649_DCDC_VMIN,
0fb737b5 AL	137	.uV_step = MAX8649_DCDC_STEP,
ea88b132 AL	138	.enable_reg = MAX8649_CONTROL,
	139	.enable_mask = MAX8649_EN_PD,
	140	.enable_is_inverted = true,
a71b797f HZ	141	};
a71b797f HZ	142
035f3324	143	static const struct regmap_config max8649_regmap_config = {
c5b68d47 JC	144	.reg_bits = 8,
	145	.val_bits = 8,
	146	};
	147
a5023574	148	static int max8649_regulator_probe(struct i2c_client *client,
a71b797f HZ	149	const struct i2c_device_id *id)
a71b797f HZ	150	{
dff91d0b	151	struct max8649_platform_data *pdata = dev_get_platdata(&client->dev);
a71b797f	152	struct max8649_regulator_info *info = NULL;
b7313b89	153	struct regulator_dev *regulator;
c172708d	154	struct regulator_config config = { };
c5b68d47	155	unsigned int val;
a71b797f HZ	156	unsigned char data;
	157	int ret;
	158
dc553a79 AL	159	info = devm_kzalloc(&client->dev, sizeof(struct max8649_regulator_info),
dc553a79 AL	160	GFP_KERNEL);
6e27e996	161	if (!info)
a71b797f	162	return -ENOMEM;
a71b797f	163
dc553a79	164	info->regmap = devm_regmap_init_i2c(client, &max8649_regmap_config);
c5b68d47 JC	165	if (IS_ERR(info->regmap)) {
	166	ret = PTR_ERR(info->regmap);
	167	dev_err(&client->dev, "Failed to allocate register map: %d\n", ret);
dc553a79	168	return ret;
c5b68d47 JC	169	}
c5b68d47 JC	170
a71b797f	171	info->dev = &client->dev;
a71b797f HZ	172	i2c_set_clientdata(client, info);
	173
	174	info->mode = pdata->mode;
	175	switch (info->mode) {
	176	case 0:
817d8c2d	177	dcdc_desc.vsel_reg = MAX8649_MODE0;
a71b797f HZ	178	break;
a71b797f HZ	179	case 1:
817d8c2d	180	dcdc_desc.vsel_reg = MAX8649_MODE1;
a71b797f HZ	181	break;
a71b797f HZ	182	case 2:
817d8c2d	183	dcdc_desc.vsel_reg = MAX8649_MODE2;
a71b797f HZ	184	break;
a71b797f HZ	185	case 3:
817d8c2d	186	dcdc_desc.vsel_reg = MAX8649_MODE3;
a71b797f HZ	187	break;
	188	default:
	189	break;
	190	}
	191
c5b68d47 JC	192	ret = regmap_read(info->regmap, MAX8649_CHIP_ID1, &val);
c5b68d47 JC	193	if (ret != 0) {
a71b797f HZ	194	dev_err(info->dev, "Failed to detect ID of MAX8649:%d\n",
a71b797f HZ	195	ret);
dc553a79	196	return ret;
a71b797f	197	}
da7de6a1	198	dev_info(info->dev, "Detected MAX8649 (ID:%x)\n", val);
a71b797f HZ	199
a71b797f HZ	200	/* enable VID0 & VID1 */
c5b68d47	201	regmap_update_bits(info->regmap, MAX8649_CONTROL, MAX8649_VID_MASK, 0);
a71b797f HZ	202
	203	/* enable/disable external clock synchronization */
	204	info->extclk = pdata->extclk;
	205	data = (info->extclk) ? MAX8649_SYNC_EXTCLK : 0;
817d8c2d AL	206	regmap_update_bits(info->regmap, dcdc_desc.vsel_reg,
817d8c2d AL	207	MAX8649_SYNC_EXTCLK, data);
a71b797f HZ	208	if (info->extclk) {
	209	/* set external clock frequency */
	210	info->extclk_freq = pdata->extclk_freq;
c5b68d47 JC	211	regmap_update_bits(info->regmap, MAX8649_SYNC, MAX8649_EXT_MASK,
c5b68d47 JC	212	info->extclk_freq << 6);
a71b797f HZ	213	}
	214
	215	if (pdata->ramp_timing) {
	216	info->ramp_timing = pdata->ramp_timing;
c5b68d47 JC	217	regmap_update_bits(info->regmap, MAX8649_RAMP, MAX8649_RAMP_MASK,
c5b68d47 JC	218	info->ramp_timing << 5);
a71b797f HZ	219	}
	220
	221	info->ramp_down = pdata->ramp_down;
	222	if (info->ramp_down) {
c5b68d47 JC	223	regmap_update_bits(info->regmap, MAX8649_RAMP, MAX8649_RAMP_DOWN,
c5b68d47 JC	224	MAX8649_RAMP_DOWN);
a71b797f HZ	225	}
a71b797f HZ	226
c172708d MB	227	config.dev = &client->dev;
	228	config.init_data = pdata->regulator;
	229	config.driver_data = info;
61663171	230	config.regmap = info->regmap;
c172708d	231
b7313b89	232	regulator = devm_regulator_register(&client->dev, &dcdc_desc,
e453f92e	233	&config);
b7313b89	234	if (IS_ERR(regulator)) {
a71b797f HZ	235	dev_err(info->dev, "failed to register regulator %s\n",
a71b797f HZ	236	dcdc_desc.name);
b7313b89	237	return PTR_ERR(regulator);
a71b797f HZ	238	}
a71b797f HZ	239
a71b797f	240	return 0;
a71b797f HZ	241	}
a71b797f HZ	242
a71b797f HZ	243	static const struct i2c_device_id max8649_id[] = {
	244	{ "max8649", 0 },
	245	{ }
	246	};
	247	MODULE_DEVICE_TABLE(i2c, max8649_id);
	248
	249	static struct i2c_driver max8649_driver = {
	250	.probe = max8649_regulator_probe,
a71b797f HZ	251	.driver = {
	252	.name = "max8649",
	253	},
	254	.id_table = max8649_id,
	255	};
	256
	257	static int __init max8649_init(void)
	258	{
	259	return i2c_add_driver(&max8649_driver);
	260	}
	261	subsys_initcall(max8649_init);
	262
	263	static void __exit max8649_exit(void)
	264	{
	265	i2c_del_driver(&max8649_driver);
	266	}
	267	module_exit(max8649_exit);
	268
	269	/* Module information */
	270	MODULE_DESCRIPTION("MAXIM 8649 voltage regulator driver");
	271	MODULE_AUTHOR("Haojian Zhuang <haojian.zhuang@marvell.com>");
	272	MODULE_LICENSE("GPL");