[mirror_ubuntu-focal-kernel.git] / drivers / mfd / da9052-i2c.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * I2C access for DA9052 PMICs.
 *
 * Copyright(c) 2011 Dialog Semiconductor Ltd.
 *
 * Author: David Dajun Chen <dchen@diasemi.com>
 */

#include <linux/device.h>
#include <linux/module.h>
#include <linux/input.h>
#include <linux/mfd/core.h>
#include <linux/i2c.h>
#include <linux/err.h>

#include <linux/mfd/da9052/da9052.h>
#include <linux/mfd/da9052/reg.h>

#ifdef CONFIG_OF
#include <linux/of.h>
#include <linux/of_device.h>
#endif

/* I2C safe register check */
static inline bool i2c_safe_reg(unsigned char reg)
{
	switch (reg) {
	case DA9052_STATUS_A_REG:
	case DA9052_STATUS_B_REG:
	case DA9052_STATUS_C_REG:
	case DA9052_STATUS_D_REG:
	case DA9052_ADC_RES_L_REG:
	case DA9052_ADC_RES_H_REG:
	case DA9052_VDD_RES_REG:
	case DA9052_ICHG_AV_REG:
	case DA9052_TBAT_RES_REG:
	case DA9052_ADCIN4_RES_REG:
	case DA9052_ADCIN5_RES_REG:
	case DA9052_ADCIN6_RES_REG:
	case DA9052_TJUNC_RES_REG:
	case DA9052_TSI_X_MSB_REG:
	case DA9052_TSI_Y_MSB_REG:
	case DA9052_TSI_LSB_REG:
	case DA9052_TSI_Z_MSB_REG:
		return true;
	default:
		return false;
	}
}

/*
 * There is an issue with DA9052 and DA9053_AA/BA/BB PMIC where the PMIC
 * gets lockup up or fails to respond following a system reset.
 * This fix is to follow any read or write with a dummy read to a safe
 * register.
 */
static int da9052_i2c_fix(struct da9052 *da9052, unsigned char reg)
{
	int val;

	switch (da9052->chip_id) {
	case DA9052:
	case DA9053_AA:
	case DA9053_BA:
	case DA9053_BB:
		/* A dummy read to a safe register address. */
		if (!i2c_safe_reg(reg))
			return regmap_read(da9052->regmap,
					   DA9052_PARK_REGISTER,
					   &val);
		break;
	case DA9053_BC:
	default:
		/*
		 * For other chips parking of I2C register
		 * to a safe place is not required.
		 */
		break;
	}

	return 0;
}

/*
 * According to errata item 24, multiwrite mode should be avoided
 * in order to prevent register data corruption after power-down.
 */
static int da9052_i2c_disable_multiwrite(struct da9052 *da9052)
{
	int reg_val, ret;

	ret = regmap_read(da9052->regmap, DA9052_CONTROL_B_REG, &reg_val);
	if (ret < 0)
		return ret;

	if (!(reg_val & DA9052_CONTROL_B_WRITEMODE)) {
		reg_val |= DA9052_CONTROL_B_WRITEMODE;
		ret = regmap_write(da9052->regmap, DA9052_CONTROL_B_REG,
				   reg_val);
		if (ret < 0)
			return ret;
	}

	return 0;
}

static const struct i2c_device_id da9052_i2c_id[] = {
	{"da9052", DA9052},
	{"da9053-aa", DA9053_AA},
	{"da9053-ba", DA9053_BA},
	{"da9053-bb", DA9053_BB},
	{"da9053-bc", DA9053_BC},
	{}
};

#ifdef CONFIG_OF
static const struct of_device_id dialog_dt_ids[] = {
	{ .compatible = "dlg,da9052", .data = &da9052_i2c_id[0] },
	{ .compatible = "dlg,da9053-aa", .data = &da9052_i2c_id[1] },
	{ .compatible = "dlg,da9053-ba", .data = &da9052_i2c_id[2] },
	{ .compatible = "dlg,da9053-bb", .data = &da9052_i2c_id[3] },
	{ .compatible = "dlg,da9053-bc", .data = &da9052_i2c_id[4] },
	{ /* sentinel */ }
};
#endif

static int da9052_i2c_probe(struct i2c_client *client,
				       const struct i2c_device_id *id)
{
	struct da9052 *da9052;
	int ret;

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

	da9052->dev = &client->dev;
	da9052->chip_irq = client->irq;
	da9052->fix_io = da9052_i2c_fix;

	i2c_set_clientdata(client, da9052);

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

	ret = da9052_i2c_disable_multiwrite(da9052);
	if (ret < 0)
		return ret;

#ifdef CONFIG_OF
	if (!id) {
		struct device_node *np = client->dev.of_node;
		const struct of_device_id *deviceid;

		deviceid = of_match_node(dialog_dt_ids, np);
		id = deviceid->data;
	}
#endif

	if (!id) {
		ret = -ENODEV;
		dev_err(&client->dev, "id is null.\n");
		return ret;
	}

	return da9052_device_init(da9052, id->driver_data);
}

static int da9052_i2c_remove(struct i2c_client *client)
{
	struct da9052 *da9052 = i2c_get_clientdata(client);

	da9052_device_exit(da9052);
	return 0;
}

static struct i2c_driver da9052_i2c_driver = {
	.probe = da9052_i2c_probe,
	.remove = da9052_i2c_remove,
	.id_table = da9052_i2c_id,
	.driver = {
		.name = "da9052",
#ifdef CONFIG_OF
		.of_match_table = dialog_dt_ids,
#endif
	},
};

static int __init da9052_i2c_init(void)
{
	int ret;

	ret = i2c_add_driver(&da9052_i2c_driver);
	if (ret != 0) {
		pr_err("DA9052 I2C registration failed %d\n", ret);
		return ret;
	}

	return 0;
}
subsys_initcall(da9052_i2c_init);

static void __exit da9052_i2c_exit(void)
{
	i2c_del_driver(&da9052_i2c_driver);
}
module_exit(da9052_i2c_exit);

MODULE_AUTHOR("David Dajun Chen <dchen@diasemi.com>");
MODULE_DESCRIPTION("I2C driver for Dialog DA9052 PMIC");
MODULE_LICENSE("GPL");
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
84c99db8 AJ	2	/*
	3	* I2C access for DA9052 PMICs.
	4	*
	5	* Copyright(c) 2011 Dialog Semiconductor Ltd.
	6	*
	7	* Author: David Dajun Chen <dchen@diasemi.com>
84c99db8 AJ	8	*/
	9
	10	#include <linux/device.h>
	11	#include <linux/module.h>
	12	#include <linux/input.h>
	13	#include <linux/mfd/core.h>
	14	#include <linux/i2c.h>
	15	#include <linux/err.h>
	16
	17	#include <linux/mfd/da9052/da9052.h>
	18	#include <linux/mfd/da9052/reg.h>
	19
58d114b6 YCLP	20	#ifdef CONFIG_OF
	21	#include <linux/of.h>
	22	#include <linux/of_device.h>
	23	#endif
	24
0a8c290a AJ	25	/* I2C safe register check */
	26	static inline bool i2c_safe_reg(unsigned char reg)
	27	{
	28	switch (reg) {
	29	case DA9052_STATUS_A_REG:
	30	case DA9052_STATUS_B_REG:
	31	case DA9052_STATUS_C_REG:
	32	case DA9052_STATUS_D_REG:
	33	case DA9052_ADC_RES_L_REG:
	34	case DA9052_ADC_RES_H_REG:
	35	case DA9052_VDD_RES_REG:
	36	case DA9052_ICHG_AV_REG:
	37	case DA9052_TBAT_RES_REG:
	38	case DA9052_ADCIN4_RES_REG:
	39	case DA9052_ADCIN5_RES_REG:
	40	case DA9052_ADCIN6_RES_REG:
	41	case DA9052_TJUNC_RES_REG:
	42	case DA9052_TSI_X_MSB_REG:
	43	case DA9052_TSI_Y_MSB_REG:
	44	case DA9052_TSI_LSB_REG:
	45	case DA9052_TSI_Z_MSB_REG:
	46	return true;
	47	default:
	48	return false;
	49	}
	50	}
	51
	52	/*
	53	* There is an issue with DA9052 and DA9053_AA/BA/BB PMIC where the PMIC
	54	* gets lockup up or fails to respond following a system reset.
	55	* This fix is to follow any read or write with a dummy read to a safe
	56	* register.
	57	*/
c3e9e6b6	58	static int da9052_i2c_fix(struct da9052 *da9052, unsigned char reg)
0a8c290a AJ	59	{
	60	int val;
	61
	62	switch (da9052->chip_id) {
	63	case DA9052:
	64	case DA9053_AA:
	65	case DA9053_BA:
	66	case DA9053_BB:
	67	/* A dummy read to a safe register address. */
5b7b2ac1	68	if (!i2c_safe_reg(reg))
0a8c290a AJ	69	return regmap_read(da9052->regmap,
	70	DA9052_PARK_REGISTER,
	71	&val);
	72	break;
6c049b2a	73	case DA9053_BC:
0a8c290a AJ	74	default:
	75	/*
	76	* For other chips parking of I2C register
	77	* to a safe place is not required.
	78	*/
	79	break;
	80	}
	81
	82	return 0;
	83	}
0a8c290a	84
43e30f23 DJ	85	/*
	86	* According to errata item 24, multiwrite mode should be avoided
	87	* in order to prevent register data corruption after power-down.
	88	*/
	89	static int da9052_i2c_disable_multiwrite(struct da9052 *da9052)
84c99db8 AJ	90	{
	91	int reg_val, ret;
	92
	93	ret = regmap_read(da9052->regmap, DA9052_CONTROL_B_REG, &reg_val);
	94	if (ret < 0)
	95	return ret;
	96
43e30f23 DJ	97	if (!(reg_val & DA9052_CONTROL_B_WRITEMODE)) {
43e30f23 DJ	98	reg_val \|= DA9052_CONTROL_B_WRITEMODE;
84c99db8 AJ	99	ret = regmap_write(da9052->regmap, DA9052_CONTROL_B_REG,
	100	reg_val);
	101	if (ret < 0)
	102	return ret;
	103	}
	104
	105	return 0;
	106	}
	107
e27d650b	108	static const struct i2c_device_id da9052_i2c_id[] = {
58d114b6 YCLP	109	{"da9052", DA9052},
	110	{"da9053-aa", DA9053_AA},
	111	{"da9053-ba", DA9053_BA},
	112	{"da9053-bb", DA9053_BB},
6c049b2a	113	{"da9053-bc", DA9053_BC},
58d114b6 YCLP	114	{}
	115	};
	116
	117	#ifdef CONFIG_OF
	118	static const struct of_device_id dialog_dt_ids[] = {
	119	{ .compatible = "dlg,da9052", .data = &da9052_i2c_id[0] },
	120	{ .compatible = "dlg,da9053-aa", .data = &da9052_i2c_id[1] },
6c049b2a	121	{ .compatible = "dlg,da9053-ba", .data = &da9052_i2c_id[2] },
58d114b6	122	{ .compatible = "dlg,da9053-bb", .data = &da9052_i2c_id[3] },
6c049b2a	123	{ .compatible = "dlg,da9053-bc", .data = &da9052_i2c_id[4] },
58d114b6 YCLP	124	{ /* sentinel */ }
	125	};
	126	#endif
	127
f791be49	128	static int da9052_i2c_probe(struct i2c_client *client,
84c99db8 AJ	129	const struct i2c_device_id *id)
	130	{
	131	struct da9052 *da9052;
	132	int ret;
	133
6608a5e2	134	da9052 = devm_kzalloc(&client->dev, sizeof(struct da9052), GFP_KERNEL);
84c99db8 AJ	135	if (!da9052)
	136	return -ENOMEM;
	137
84c99db8 AJ	138	da9052->dev = &client->dev;
84c99db8 AJ	139	da9052->chip_irq = client->irq;
0a8c290a	140	da9052->fix_io = da9052_i2c_fix;
84c99db8 AJ	141
	142	i2c_set_clientdata(client, da9052);
	143
6608a5e2	144	da9052->regmap = devm_regmap_init_i2c(client, &da9052_regmap_config);
84c99db8 AJ	145	if (IS_ERR(da9052->regmap)) {
	146	ret = PTR_ERR(da9052->regmap);
	147	dev_err(&client->dev, "Failed to allocate register map: %d\n",
	148	ret);
6608a5e2	149	return ret;
84c99db8 AJ	150	}
84c99db8 AJ	151
43e30f23	152	ret = da9052_i2c_disable_multiwrite(da9052);
84c99db8	153	if (ret < 0)
6608a5e2	154	return ret;
84c99db8	155
58d114b6 YCLP	156	#ifdef CONFIG_OF
	157	if (!id) {
	158	struct device_node *np = client->dev.of_node;
	159	const struct of_device_id *deviceid;
	160
9e69ab41	161	deviceid = of_match_node(dialog_dt_ids, np);
e27d650b	162	id = deviceid->data;
58d114b6 YCLP	163	}
	164	#endif
	165
	166	if (!id) {
	167	ret = -ENODEV;
	168	dev_err(&client->dev, "id is null.\n");
6608a5e2	169	return ret;
58d114b6 YCLP	170	}
58d114b6 YCLP	171
ad698ea4	172	return da9052_device_init(da9052, id->driver_data);
84c99db8 AJ	173	}
84c99db8 AJ	174
4740f73f	175	static int da9052_i2c_remove(struct i2c_client *client)
84c99db8 AJ	176	{
	177	struct da9052 *da9052 = i2c_get_clientdata(client);
	178
	179	da9052_device_exit(da9052);
84c99db8 AJ	180	return 0;
	181	}
	182
84c99db8 AJ	183	static struct i2c_driver da9052_i2c_driver = {
84c99db8 AJ	184	.probe = da9052_i2c_probe,
84449216	185	.remove = da9052_i2c_remove,
84c99db8 AJ	186	.id_table = da9052_i2c_id,
	187	.driver = {
	188	.name = "da9052",
58d114b6 YCLP	189	#ifdef CONFIG_OF
	190	.of_match_table = dialog_dt_ids,
	191	#endif
84c99db8 AJ	192	},
	193	};
	194
	195	static int __init da9052_i2c_init(void)
	196	{
	197	int ret;
	198
	199	ret = i2c_add_driver(&da9052_i2c_driver);
	200	if (ret != 0) {
	201	pr_err("DA9052 I2C registration failed %d\n", ret);
	202	return ret;
	203	}
	204
	205	return 0;
	206	}
	207	subsys_initcall(da9052_i2c_init);
	208
	209	static void __exit da9052_i2c_exit(void)
	210	{
	211	i2c_del_driver(&da9052_i2c_driver);
	212	}
	213	module_exit(da9052_i2c_exit);
	214
	215	MODULE_AUTHOR("David Dajun Chen <dchen@diasemi.com>");
	216	MODULE_DESCRIPTION("I2C driver for Dialog DA9052 PMIC");
	217	MODULE_LICENSE("GPL");