[mirror_ubuntu-hirsute-kernel.git] / drivers / mfd / ti-lmu.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * TI LMU (Lighting Management Unit) Core Driver
 *
 * Copyright 2017 Texas Instruments
 *
 * Author: Milo Kim <milo.kim@ti.com>
 */

#include <linux/delay.h>
#include <linux/err.h>
#include <linux/gpio/consumer.h>
#include <linux/i2c.h>
#include <linux/kernel.h>
#include <linux/mfd/core.h>
#include <linux/mfd/ti-lmu.h>
#include <linux/mfd/ti-lmu-register.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_device.h>
#include <linux/slab.h>

struct ti_lmu_data {
	const struct mfd_cell *cells;
	int num_cells;
	unsigned int max_register;
};

static int ti_lmu_enable_hw(struct ti_lmu *lmu, enum ti_lmu_id id)
{
	if (lmu->en_gpio)
		gpiod_set_value(lmu->en_gpio, 1);

	/* Delay about 1ms after HW enable pin control */
	usleep_range(1000, 1500);

	/* LM3631 has additional power up sequence - enable LCD_EN bit. */
	if (id == LM3631) {
		return regmap_update_bits(lmu->regmap, LM3631_REG_DEVCTRL,
					  LM3631_LCD_EN_MASK,
					  LM3631_LCD_EN_MASK);
	}

	return 0;
}

static void ti_lmu_disable_hw(void *data)
{
	struct ti_lmu *lmu = data;
	if (lmu->en_gpio)
		gpiod_set_value(lmu->en_gpio, 0);
}

#define LM363X_REGULATOR(_id)			\
{						\
	.name          = "lm363x-regulator",	\
	.id            = _id,			\
	.of_compatible = "ti,lm363x-regulator",	\
}						\

static const struct mfd_cell lm3631_devices[] = {
	LM363X_REGULATOR(LM3631_BOOST),
	LM363X_REGULATOR(LM3631_LDO_CONT),
	LM363X_REGULATOR(LM3631_LDO_OREF),
	LM363X_REGULATOR(LM3631_LDO_POS),
	LM363X_REGULATOR(LM3631_LDO_NEG),
	{
		.name          = "ti-lmu-backlight",
		.id            = LM3631,
		.of_compatible = "ti,lm3631-backlight",
	},
};

static const struct mfd_cell lm3632_devices[] = {
	LM363X_REGULATOR(LM3632_BOOST),
	LM363X_REGULATOR(LM3632_LDO_POS),
	LM363X_REGULATOR(LM3632_LDO_NEG),
	{
		.name          = "ti-lmu-backlight",
		.id            = LM3632,
		.of_compatible = "ti,lm3632-backlight",
	},
};

static const struct mfd_cell lm3633_devices[] = {
	{
		.name          = "ti-lmu-backlight",
		.id            = LM3633,
		.of_compatible = "ti,lm3633-backlight",
	},
	{
		.name          = "lm3633-leds",
		.of_compatible = "ti,lm3633-leds",
	},
	/* Monitoring driver for open/short circuit detection */
	{
		.name          = "ti-lmu-fault-monitor",
		.id            = LM3633,
		.of_compatible = "ti,lm3633-fault-monitor",
	},
};

static const struct mfd_cell lm3695_devices[] = {
	{
		.name          = "ti-lmu-backlight",
		.id            = LM3695,
		.of_compatible = "ti,lm3695-backlight",
	},
};

static const struct mfd_cell lm36274_devices[] = {
	LM363X_REGULATOR(LM36274_BOOST),
	LM363X_REGULATOR(LM36274_LDO_POS),
	LM363X_REGULATOR(LM36274_LDO_NEG),
	{
		.name          = "lm36274-leds",
		.id            = LM36274,
		.of_compatible = "ti,lm36274-backlight",
	},
};

#define TI_LMU_DATA(chip, max_reg)		\
static const struct ti_lmu_data chip##_data =	\
{						\
	.cells = chip##_devices,		\
	.num_cells = ARRAY_SIZE(chip##_devices),\
	.max_register = max_reg,		\
}						\

TI_LMU_DATA(lm3631, LM3631_MAX_REG);
TI_LMU_DATA(lm3632, LM3632_MAX_REG);
TI_LMU_DATA(lm3633, LM3633_MAX_REG);
TI_LMU_DATA(lm3695, LM3695_MAX_REG);
TI_LMU_DATA(lm36274, LM36274_MAX_REG);

static int ti_lmu_probe(struct i2c_client *cl, const struct i2c_device_id *id)
{
	struct device *dev = &cl->dev;
	const struct ti_lmu_data *data;
	struct regmap_config regmap_cfg;
	struct ti_lmu *lmu;
	int ret;

	/*
	 * Get device specific data from of_match table.
	 * This data is defined by using TI_LMU_DATA() macro.
	 */
	data = of_device_get_match_data(dev);
	if (!data)
		return -ENODEV;

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

	lmu->dev = &cl->dev;

	/* Setup regmap */
	memset(&regmap_cfg, 0, sizeof(struct regmap_config));
	regmap_cfg.reg_bits = 8;
	regmap_cfg.val_bits = 8;
	regmap_cfg.name = id->name;
	regmap_cfg.max_register = data->max_register;

	lmu->regmap = devm_regmap_init_i2c(cl, &regmap_cfg);
	if (IS_ERR(lmu->regmap))
		return PTR_ERR(lmu->regmap);

	/* HW enable pin control and additional power up sequence if required */
	lmu->en_gpio = devm_gpiod_get_optional(dev, "enable", GPIOD_OUT_HIGH);
	if (IS_ERR(lmu->en_gpio)) {
		ret = PTR_ERR(lmu->en_gpio);
		dev_err(dev, "Can not request enable GPIO: %d\n", ret);
		return ret;
	}

	ret = ti_lmu_enable_hw(lmu, id->driver_data);
	if (ret)
		return ret;

	ret = devm_add_action_or_reset(dev, ti_lmu_disable_hw, lmu);
	if (ret)
		return ret;

	/*
	 * Fault circuit(open/short) can be detected by ti-lmu-fault-monitor.
	 * After fault detection is done, some devices should re-initialize
	 * configuration. The notifier enables such kind of handling.
	 */
	BLOCKING_INIT_NOTIFIER_HEAD(&lmu->notifier);

	i2c_set_clientdata(cl, lmu);

	return devm_mfd_add_devices(lmu->dev, 0, data->cells,
				    data->num_cells, NULL, 0, NULL);
}

static const struct of_device_id ti_lmu_of_match[] = {
	{ .compatible = "ti,lm3631", .data = &lm3631_data },
	{ .compatible = "ti,lm3632", .data = &lm3632_data },
	{ .compatible = "ti,lm3633", .data = &lm3633_data },
	{ .compatible = "ti,lm3695", .data = &lm3695_data },
	{ .compatible = "ti,lm36274", .data = &lm36274_data },
	{ }
};
MODULE_DEVICE_TABLE(of, ti_lmu_of_match);

static const struct i2c_device_id ti_lmu_ids[] = {
	{ "lm3631", LM3631 },
	{ "lm3632", LM3632 },
	{ "lm3633", LM3633 },
	{ "lm3695", LM3695 },
	{ "lm36274", LM36274 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, ti_lmu_ids);

static struct i2c_driver ti_lmu_driver = {
	.probe = ti_lmu_probe,
	.driver = {
		.name = "ti-lmu",
		.of_match_table = ti_lmu_of_match,
	},
	.id_table = ti_lmu_ids,
};

module_i2c_driver(ti_lmu_driver);

MODULE_DESCRIPTION("TI LMU MFD Core Driver");
MODULE_AUTHOR("Milo Kim");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
d5aa11bf MK	2	/*
	3	* TI LMU (Lighting Management Unit) Core Driver
	4	*
	5	* Copyright 2017 Texas Instruments
	6	*
	7	* Author: Milo Kim <milo.kim@ti.com>
d5aa11bf MK	8	*/
	9
	10	#include <linux/delay.h>
	11	#include <linux/err.h>
7a6a395b	12	#include <linux/gpio/consumer.h>
d5aa11bf MK	13	#include <linux/i2c.h>
	14	#include <linux/kernel.h>
	15	#include <linux/mfd/core.h>
	16	#include <linux/mfd/ti-lmu.h>
	17	#include <linux/mfd/ti-lmu-register.h>
	18	#include <linux/module.h>
	19	#include <linux/of.h>
	20	#include <linux/of_device.h>
d5aa11bf MK	21	#include <linux/slab.h>
	22
	23	struct ti_lmu_data {
5b6850fa	24	const struct mfd_cell *cells;
d5aa11bf MK	25	int num_cells;
	26	unsigned int max_register;
	27	};
	28
	29	static int ti_lmu_enable_hw(struct ti_lmu *lmu, enum ti_lmu_id id)
	30	{
7a6a395b PM	31	if (lmu->en_gpio)
7a6a395b PM	32	gpiod_set_value(lmu->en_gpio, 1);
d5aa11bf MK	33
	34	/* Delay about 1ms after HW enable pin control */
	35	usleep_range(1000, 1500);
	36
	37	/* LM3631 has additional power up sequence - enable LCD_EN bit. */
	38	if (id == LM3631) {
	39	return regmap_update_bits(lmu->regmap, LM3631_REG_DEVCTRL,
	40	LM3631_LCD_EN_MASK,
	41	LM3631_LCD_EN_MASK);
	42	}
	43
	44	return 0;
	45	}
	46
7891d375	47	static void ti_lmu_disable_hw(void *data)
d5aa11bf	48	{
7891d375	49	struct ti_lmu *lmu = data;
7a6a395b PM	50	if (lmu->en_gpio)
7a6a395b PM	51	gpiod_set_value(lmu->en_gpio, 0);
d5aa11bf MK	52	}
d5aa11bf MK	53
d5aa11bf MK	54	#define LM363X_REGULATOR(_id) \
	55	{ \
	56	.name = "lm363x-regulator", \
	57	.id = _id, \
	58	.of_compatible = "ti,lm363x-regulator", \
	59	} \
	60
5b6850fa	61	static const struct mfd_cell lm3631_devices[] = {
d5aa11bf MK	62	LM363X_REGULATOR(LM3631_BOOST),
	63	LM363X_REGULATOR(LM3631_LDO_CONT),
	64	LM363X_REGULATOR(LM3631_LDO_OREF),
	65	LM363X_REGULATOR(LM3631_LDO_POS),
	66	LM363X_REGULATOR(LM3631_LDO_NEG),
	67	{
	68	.name = "ti-lmu-backlight",
	69	.id = LM3631,
	70	.of_compatible = "ti,lm3631-backlight",
	71	},
	72	};
	73
5b6850fa	74	static const struct mfd_cell lm3632_devices[] = {
d5aa11bf MK	75	LM363X_REGULATOR(LM3632_BOOST),
	76	LM363X_REGULATOR(LM3632_LDO_POS),
	77	LM363X_REGULATOR(LM3632_LDO_NEG),
	78	{
	79	.name = "ti-lmu-backlight",
	80	.id = LM3632,
	81	.of_compatible = "ti,lm3632-backlight",
	82	},
	83	};
	84
5b6850fa	85	static const struct mfd_cell lm3633_devices[] = {
d5aa11bf MK	86	{
	87	.name = "ti-lmu-backlight",
	88	.id = LM3633,
	89	.of_compatible = "ti,lm3633-backlight",
	90	},
	91	{
	92	.name = "lm3633-leds",
	93	.of_compatible = "ti,lm3633-leds",
	94	},
	95	/* Monitoring driver for open/short circuit detection */
	96	{
	97	.name = "ti-lmu-fault-monitor",
	98	.id = LM3633,
	99	.of_compatible = "ti,lm3633-fault-monitor",
	100	},
	101	};
	102
5b6850fa	103	static const struct mfd_cell lm3695_devices[] = {
d5aa11bf MK	104	{
	105	.name = "ti-lmu-backlight",
	106	.id = LM3695,
	107	.of_compatible = "ti,lm3695-backlight",
	108	},
	109	};
	110
9c523efb DM	111	static const struct mfd_cell lm36274_devices[] = {
	112	LM363X_REGULATOR(LM36274_BOOST),
	113	LM363X_REGULATOR(LM36274_LDO_POS),
	114	LM363X_REGULATOR(LM36274_LDO_NEG),
d5aa11bf	115	{
9c523efb DM	116	.name = "lm36274-leds",
	117	.id = LM36274,
	118	.of_compatible = "ti,lm36274-backlight",
d5aa11bf MK	119	},
	120	};
	121
	122	#define TI_LMU_DATA(chip, max_reg) \
	123	static const struct ti_lmu_data chip##_data = \
	124	{ \
	125	.cells = chip##_devices, \
	126	.num_cells = ARRAY_SIZE(chip##_devices),\
	127	.max_register = max_reg, \
	128	} \
	129
d5aa11bf MK	130	TI_LMU_DATA(lm3631, LM3631_MAX_REG);
	131	TI_LMU_DATA(lm3632, LM3632_MAX_REG);
	132	TI_LMU_DATA(lm3633, LM3633_MAX_REG);
	133	TI_LMU_DATA(lm3695, LM3695_MAX_REG);
9c523efb	134	TI_LMU_DATA(lm36274, LM36274_MAX_REG);
d5aa11bf	135
d5aa11bf MK	136	static int ti_lmu_probe(struct i2c_client cl, const struct i2c_device_id id)
	137	{
	138	struct device *dev = &cl->dev;
d5aa11bf MK	139	const struct ti_lmu_data *data;
	140	struct regmap_config regmap_cfg;
	141	struct ti_lmu *lmu;
	142	int ret;
	143
d5aa11bf MK	144	/*
	145	* Get device specific data from of_match table.
	146	* This data is defined by using TI_LMU_DATA() macro.
	147	*/
697894b9 PM	148	data = of_device_get_match_data(dev);
	149	if (!data)
	150	return -ENODEV;
d5aa11bf MK	151
	152	lmu = devm_kzalloc(dev, sizeof(*lmu), GFP_KERNEL);
	153	if (!lmu)
	154	return -ENOMEM;
	155
	156	lmu->dev = &cl->dev;
	157
	158	/* Setup regmap */
	159	memset(&regmap_cfg, 0, sizeof(struct regmap_config));
	160	regmap_cfg.reg_bits = 8;
	161	regmap_cfg.val_bits = 8;
	162	regmap_cfg.name = id->name;
	163	regmap_cfg.max_register = data->max_register;
	164
	165	lmu->regmap = devm_regmap_init_i2c(cl, &regmap_cfg);
	166	if (IS_ERR(lmu->regmap))
	167	return PTR_ERR(lmu->regmap);
	168
	169	/* HW enable pin control and additional power up sequence if required */
7a6a395b PM	170	lmu->en_gpio = devm_gpiod_get_optional(dev, "enable", GPIOD_OUT_HIGH);
	171	if (IS_ERR(lmu->en_gpio)) {
	172	ret = PTR_ERR(lmu->en_gpio);
	173	dev_err(dev, "Can not request enable GPIO: %d\n", ret);
	174	return ret;
	175	}
	176
d5aa11bf MK	177	ret = ti_lmu_enable_hw(lmu, id->driver_data);
	178	if (ret)
	179	return ret;
	180
7891d375 PM	181	ret = devm_add_action_or_reset(dev, ti_lmu_disable_hw, lmu);
	182	if (ret)
	183	return ret;
	184
d5aa11bf MK	185	/*
	186	* Fault circuit(open/short) can be detected by ti-lmu-fault-monitor.
	187	* After fault detection is done, some devices should re-initialize
	188	* configuration. The notifier enables such kind of handling.
	189	*/
	190	BLOCKING_INIT_NOTIFIER_HEAD(&lmu->notifier);
	191
	192	i2c_set_clientdata(cl, lmu);
	193
7891d375 PM	194	return devm_mfd_add_devices(lmu->dev, 0, data->cells,
7891d375 PM	195	data->num_cells, NULL, 0, NULL);
d5aa11bf MK	196	}
d5aa11bf MK	197
697894b9	198	static const struct of_device_id ti_lmu_of_match[] = {
697894b9 PM	199	{ .compatible = "ti,lm3631", .data = &lm3631_data },
	200	{ .compatible = "ti,lm3632", .data = &lm3632_data },
	201	{ .compatible = "ti,lm3633", .data = &lm3633_data },
	202	{ .compatible = "ti,lm3695", .data = &lm3695_data },
9c523efb	203	{ .compatible = "ti,lm36274", .data = &lm36274_data },
697894b9 PM	204	{ }
	205	};
	206	MODULE_DEVICE_TABLE(of, ti_lmu_of_match);
	207
d5aa11bf	208	static const struct i2c_device_id ti_lmu_ids[] = {
d5aa11bf MK	209	{ "lm3631", LM3631 },
	210	{ "lm3632", LM3632 },
	211	{ "lm3633", LM3633 },
	212	{ "lm3695", LM3695 },
9c523efb	213	{ "lm36274", LM36274 },
d5aa11bf MK	214	{ }
	215	};
	216	MODULE_DEVICE_TABLE(i2c, ti_lmu_ids);
	217
	218	static struct i2c_driver ti_lmu_driver = {
	219	.probe = ti_lmu_probe,
d5aa11bf MK	220	.driver = {
	221	.name = "ti-lmu",
	222	.of_match_table = ti_lmu_of_match,
	223	},
	224	.id_table = ti_lmu_ids,
	225	};
	226
	227	module_i2c_driver(ti_lmu_driver);
	228
	229	MODULE_DESCRIPTION("TI LMU MFD Core Driver");
	230	MODULE_AUTHOR("Milo Kim");
	231	MODULE_LICENSE("GPL v2");