[linux.git] / drivers / mfd / max77686.c

// SPDX-License-Identifier: GPL-2.0+
//
// max77686.c - mfd core driver for the Maxim 77686/802
//
// Copyright (C) 2012 Samsung Electronics
// Chiwoong Byun <[email protected]>
// Jonghwa Lee <[email protected]>
//
//This driver is based on max8997.c

#include <linux/export.h>
#include <linux/slab.h>
#include <linux/i2c.h>
#include <linux/irq.h>
#include <linux/interrupt.h>
#include <linux/pm_runtime.h>
#include <linux/module.h>
#include <linux/mfd/core.h>
#include <linux/mfd/max77686.h>
#include <linux/mfd/max77686-private.h>
#include <linux/err.h>
#include <linux/of.h>
#include <linux/of_device.h>

static const struct mfd_cell max77686_devs[] = {
	{ .name = "max77686-pmic", },
	{ .name = "max77686-rtc", },
	{ .name = "max77686-clk", },
};

static const struct mfd_cell max77802_devs[] = {
	{ .name = "max77802-pmic", },
	{ .name = "max77802-clk", },
	{ .name = "max77802-rtc", },
};

static bool max77802_pmic_is_accessible_reg(struct device *dev,
					    unsigned int reg)
{
	return reg < MAX77802_REG_PMIC_END;
}

static bool max77802_rtc_is_accessible_reg(struct device *dev,
					   unsigned int reg)
{
	return (reg >= MAX77802_RTC_INT && reg < MAX77802_RTC_END);
}

static bool max77802_is_accessible_reg(struct device *dev, unsigned int reg)
{
	return (max77802_pmic_is_accessible_reg(dev, reg) ||
		max77802_rtc_is_accessible_reg(dev, reg));
}

static bool max77802_pmic_is_precious_reg(struct device *dev, unsigned int reg)
{
	return (reg == MAX77802_REG_INTSRC || reg == MAX77802_REG_INT1 ||
		reg == MAX77802_REG_INT2);
}

static bool max77802_rtc_is_precious_reg(struct device *dev, unsigned int reg)
{
	return (reg == MAX77802_RTC_INT ||
		reg == MAX77802_RTC_UPDATE0 ||
		reg == MAX77802_RTC_UPDATE1);
}

static bool max77802_is_precious_reg(struct device *dev, unsigned int reg)
{
	return (max77802_pmic_is_precious_reg(dev, reg) ||
		max77802_rtc_is_precious_reg(dev, reg));
}

static bool max77802_pmic_is_volatile_reg(struct device *dev, unsigned int reg)
{
	return (max77802_is_precious_reg(dev, reg) ||
		reg == MAX77802_REG_STATUS1 || reg == MAX77802_REG_STATUS2 ||
		reg == MAX77802_REG_PWRON);
}

static bool max77802_rtc_is_volatile_reg(struct device *dev, unsigned int reg)
{
	return (max77802_rtc_is_precious_reg(dev, reg) ||
		reg == MAX77802_RTC_SEC ||
		reg == MAX77802_RTC_MIN ||
		reg == MAX77802_RTC_HOUR ||
		reg == MAX77802_RTC_WEEKDAY ||
		reg == MAX77802_RTC_MONTH ||
		reg == MAX77802_RTC_YEAR ||
		reg == MAX77802_RTC_DATE);
}

static bool max77802_is_volatile_reg(struct device *dev, unsigned int reg)
{
	return (max77802_pmic_is_volatile_reg(dev, reg) ||
		max77802_rtc_is_volatile_reg(dev, reg));
}

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

static const struct regmap_config max77802_regmap_config = {
	.reg_bits = 8,
	.val_bits = 8,
	.writeable_reg = max77802_is_accessible_reg,
	.readable_reg = max77802_is_accessible_reg,
	.precious_reg = max77802_is_precious_reg,
	.volatile_reg = max77802_is_volatile_reg,
	.name = "max77802-pmic",
	.cache_type = REGCACHE_RBTREE,
};

static const struct regmap_irq max77686_irqs[] = {
	/* INT1 interrupts */
	{ .reg_offset = 0, .mask = MAX77686_INT1_PWRONF_MSK, },
	{ .reg_offset = 0, .mask = MAX77686_INT1_PWRONR_MSK, },
	{ .reg_offset = 0, .mask = MAX77686_INT1_JIGONBF_MSK, },
	{ .reg_offset = 0, .mask = MAX77686_INT1_JIGONBR_MSK, },
	{ .reg_offset = 0, .mask = MAX77686_INT1_ACOKBF_MSK, },
	{ .reg_offset = 0, .mask = MAX77686_INT1_ACOKBR_MSK, },
	{ .reg_offset = 0, .mask = MAX77686_INT1_ONKEY1S_MSK, },
	{ .reg_offset = 0, .mask = MAX77686_INT1_MRSTB_MSK, },
	/* INT2 interrupts */
	{ .reg_offset = 1, .mask = MAX77686_INT2_140C_MSK, },
	{ .reg_offset = 1, .mask = MAX77686_INT2_120C_MSK, },
};

static const struct regmap_irq_chip max77686_irq_chip = {
	.name			= "max77686-pmic",
	.status_base		= MAX77686_REG_INT1,
	.mask_base		= MAX77686_REG_INT1MSK,
	.num_regs		= 2,
	.irqs			= max77686_irqs,
	.num_irqs		= ARRAY_SIZE(max77686_irqs),
};

static const struct regmap_irq_chip max77802_irq_chip = {
	.name			= "max77802-pmic",
	.status_base		= MAX77802_REG_INT1,
	.mask_base		= MAX77802_REG_INT1MSK,
	.num_regs		= 2,
	.irqs			= max77686_irqs, /* same masks as 77686 */
	.num_irqs		= ARRAY_SIZE(max77686_irqs),
};

static const struct of_device_id max77686_pmic_dt_match[] = {
	{
		.compatible = "maxim,max77686",
		.data = (void *)TYPE_MAX77686,
	},
	{
		.compatible = "maxim,max77802",
		.data = (void *)TYPE_MAX77802,
	},
	{ },
};
MODULE_DEVICE_TABLE(of, max77686_pmic_dt_match);

static int max77686_i2c_probe(struct i2c_client *i2c)
{
	struct max77686_dev *max77686 = NULL;
	unsigned int data;
	int ret = 0;
	const struct regmap_config *config;
	const struct regmap_irq_chip *irq_chip;
	const struct mfd_cell *cells;
	int n_devs;

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

	i2c_set_clientdata(i2c, max77686);
	max77686->type = (unsigned long)of_device_get_match_data(&i2c->dev);
	max77686->dev = &i2c->dev;
	max77686->i2c = i2c;

	max77686->irq = i2c->irq;

	if (max77686->type == TYPE_MAX77686) {
		config = &max77686_regmap_config;
		irq_chip = &max77686_irq_chip;
		cells =  max77686_devs;
		n_devs = ARRAY_SIZE(max77686_devs);
	} else {
		config = &max77802_regmap_config;
		irq_chip = &max77802_irq_chip;
		cells =  max77802_devs;
		n_devs = ARRAY_SIZE(max77802_devs);
	}

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

	ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
	if (ret < 0) {
		dev_err(max77686->dev,
			"device not found on this channel (this is not an error)\n");
		return -ENODEV;
	}

	ret = devm_regmap_add_irq_chip(&i2c->dev, max77686->regmap,
				       max77686->irq,
				       IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
				       IRQF_SHARED, 0, irq_chip,
				       &max77686->irq_data);
	if (ret < 0) {
		dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
		return ret;
	}

	ret = devm_mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL,
				   0, NULL);
	if (ret < 0) {
		dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
		return ret;
	}

	return 0;
}

#ifdef CONFIG_PM_SLEEP
static int max77686_suspend(struct device *dev)
{
	struct i2c_client *i2c = to_i2c_client(dev);
	struct max77686_dev *max77686 = i2c_get_clientdata(i2c);

	if (device_may_wakeup(dev))
		enable_irq_wake(max77686->irq);

	/*
	 * IRQ must be disabled during suspend because if it happens
	 * while suspended it will be handled before resuming I2C.
	 *
	 * When device is woken up from suspend (e.g. by RTC wake alarm),
	 * an interrupt occurs before resuming I2C bus controller.
	 * Interrupt handler tries to read registers but this read
	 * will fail because I2C is still suspended.
	 */
	disable_irq(max77686->irq);

	return 0;
}

static int max77686_resume(struct device *dev)
{
	struct i2c_client *i2c = to_i2c_client(dev);
	struct max77686_dev *max77686 = i2c_get_clientdata(i2c);

	if (device_may_wakeup(dev))
		disable_irq_wake(max77686->irq);

	enable_irq(max77686->irq);

	return 0;
}
#endif /* CONFIG_PM_SLEEP */

static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);

static struct i2c_driver max77686_i2c_driver = {
	.driver = {
		   .name = "max77686",
		   .pm = &max77686_pm,
		   .of_match_table = of_match_ptr(max77686_pmic_dt_match),
	},
	.probe_new = max77686_i2c_probe,
};

module_i2c_driver(max77686_i2c_driver);

MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
MODULE_AUTHOR("Chiwoong Byun <[email protected]>");
MODULE_LICENSE("GPL");
Commit	Line	Data
d7d8d7a2 KK	1	// SPDX-License-Identifier: GPL-2.0+
	2	//
	3	// max77686.c - mfd core driver for the Maxim 77686/802
	4	//
	5	// Copyright (C) 2012 Samsung Electronics
	6	// Chiwoong Byun <[email protected]>
	7	// Jonghwa Lee <[email protected]>
	8	//
	9	//This driver is based on max8997.c
dae8a969 JL	10
	11	#include <linux/export.h>
	12	#include <linux/slab.h>
	13	#include <linux/i2c.h>
6f1c1e71 JMC	14	#include <linux/irq.h>
6f1c1e71 JMC	15	#include <linux/interrupt.h>
dae8a969 JL	16	#include <linux/pm_runtime.h>
dae8a969 JL	17	#include <linux/module.h>
dae8a969 JL	18	#include <linux/mfd/core.h>
	19	#include <linux/mfd/max77686.h>
	20	#include <linux/mfd/max77686-private.h>
	21	#include <linux/err.h>
2a048d3b	22	#include <linux/of.h>
68e61f75	23	#include <linux/of_device.h>
dae8a969	24
7c0517b1	25	static const struct mfd_cell max77686_devs[] = {
dae8a969 JL	26	{ .name = "max77686-pmic", },
dae8a969 JL	27	{ .name = "max77686-rtc", },
c0fa7e10	28	{ .name = "max77686-clk", },
dae8a969 JL	29	};
dae8a969 JL	30
a259f389 JMC	31	static const struct mfd_cell max77802_devs[] = {
	32	{ .name = "max77802-pmic", },
	33	{ .name = "max77802-clk", },
	34	{ .name = "max77802-rtc", },
	35	};
	36
	37	static bool max77802_pmic_is_accessible_reg(struct device *dev,
	38	unsigned int reg)
	39	{
b87d9a0f	40	return reg < MAX77802_REG_PMIC_END;
a259f389 JMC	41	}
	42
	43	static bool max77802_rtc_is_accessible_reg(struct device *dev,
	44	unsigned int reg)
	45	{
	46	return (reg >= MAX77802_RTC_INT && reg < MAX77802_RTC_END);
	47	}
	48
	49	static bool max77802_is_accessible_reg(struct device *dev, unsigned int reg)
	50	{
	51	return (max77802_pmic_is_accessible_reg(dev, reg) \|\|
	52	max77802_rtc_is_accessible_reg(dev, reg));
	53	}
	54
	55	static bool max77802_pmic_is_precious_reg(struct device *dev, unsigned int reg)
	56	{
	57	return (reg == MAX77802_REG_INTSRC \|\| reg == MAX77802_REG_INT1 \|\|
	58	reg == MAX77802_REG_INT2);
	59	}
	60
	61	static bool max77802_rtc_is_precious_reg(struct device *dev, unsigned int reg)
	62	{
	63	return (reg == MAX77802_RTC_INT \|\|
	64	reg == MAX77802_RTC_UPDATE0 \|\|
	65	reg == MAX77802_RTC_UPDATE1);
	66	}
	67
	68	static bool max77802_is_precious_reg(struct device *dev, unsigned int reg)
	69	{
	70	return (max77802_pmic_is_precious_reg(dev, reg) \|\|
	71	max77802_rtc_is_precious_reg(dev, reg));
	72	}
	73
	74	static bool max77802_pmic_is_volatile_reg(struct device *dev, unsigned int reg)
	75	{
	76	return (max77802_is_precious_reg(dev, reg) \|\|
	77	reg == MAX77802_REG_STATUS1 \|\| reg == MAX77802_REG_STATUS2 \|\|
	78	reg == MAX77802_REG_PWRON);
	79	}
	80
	81	static bool max77802_rtc_is_volatile_reg(struct device *dev, unsigned int reg)
	82	{
	83	return (max77802_rtc_is_precious_reg(dev, reg) \|\|
	84	reg == MAX77802_RTC_SEC \|\|
	85	reg == MAX77802_RTC_MIN \|\|
	86	reg == MAX77802_RTC_HOUR \|\|
	87	reg == MAX77802_RTC_WEEKDAY \|\|
	88	reg == MAX77802_RTC_MONTH \|\|
	89	reg == MAX77802_RTC_YEAR \|\|
	90	reg == MAX77802_RTC_DATE);
	91	}
	92
	93	static bool max77802_is_volatile_reg(struct device *dev, unsigned int reg)
	94	{
	95	return (max77802_pmic_is_volatile_reg(dev, reg) \|\|
	96	max77802_rtc_is_volatile_reg(dev, reg));
	97	}
	98
68be231c	99	static const struct regmap_config max77686_regmap_config = {
dae8a969 JL	100	.reg_bits = 8,
	101	.val_bits = 8,
	102	};
	103
68be231c	104	static const struct regmap_config max77802_regmap_config = {
a259f389 JMC	105	.reg_bits = 8,
	106	.val_bits = 8,
	107	.writeable_reg = max77802_is_accessible_reg,
	108	.readable_reg = max77802_is_accessible_reg,
	109	.precious_reg = max77802_is_precious_reg,
	110	.volatile_reg = max77802_is_volatile_reg,
	111	.name = "max77802-pmic",
	112	.cache_type = REGCACHE_RBTREE,
	113	};
	114
6f1c1e71 JMC	115	static const struct regmap_irq max77686_irqs[] = {
	116	/* INT1 interrupts */
	117	{ .reg_offset = 0, .mask = MAX77686_INT1_PWRONF_MSK, },
	118	{ .reg_offset = 0, .mask = MAX77686_INT1_PWRONR_MSK, },
	119	{ .reg_offset = 0, .mask = MAX77686_INT1_JIGONBF_MSK, },
	120	{ .reg_offset = 0, .mask = MAX77686_INT1_JIGONBR_MSK, },
	121	{ .reg_offset = 0, .mask = MAX77686_INT1_ACOKBF_MSK, },
	122	{ .reg_offset = 0, .mask = MAX77686_INT1_ACOKBR_MSK, },
	123	{ .reg_offset = 0, .mask = MAX77686_INT1_ONKEY1S_MSK, },
	124	{ .reg_offset = 0, .mask = MAX77686_INT1_MRSTB_MSK, },
	125	/* INT2 interrupts */
	126	{ .reg_offset = 1, .mask = MAX77686_INT2_140C_MSK, },
	127	{ .reg_offset = 1, .mask = MAX77686_INT2_120C_MSK, },
	128	};
	129
	130	static const struct regmap_irq_chip max77686_irq_chip = {
	131	.name = "max77686-pmic",
	132	.status_base = MAX77686_REG_INT1,
	133	.mask_base = MAX77686_REG_INT1MSK,
	134	.num_regs = 2,
	135	.irqs = max77686_irqs,
	136	.num_irqs = ARRAY_SIZE(max77686_irqs),
	137	};
	138
a259f389 JMC	139	static const struct regmap_irq_chip max77802_irq_chip = {
	140	.name = "max77802-pmic",
	141	.status_base = MAX77802_REG_INT1,
	142	.mask_base = MAX77802_REG_INT1MSK,
	143	.num_regs = 2,
	144	.irqs = max77686_irqs, /* same masks as 77686 */
	145	.num_irqs = ARRAY_SIZE(max77686_irqs),
	146	};
	147
b68ece3d	148	static const struct of_device_id max77686_pmic_dt_match[] = {
a259f389 JMC	149	{
	150	.compatible = "maxim,max77686",
	151	.data = (void *)TYPE_MAX77686,
	152	},
	153	{
	154	.compatible = "maxim,max77802",
	155	.data = (void *)TYPE_MAX77802,
	156	},
	157	{ },
2984fc00	158	};
7f8ada1a	159	MODULE_DEVICE_TABLE(of, max77686_pmic_dt_match);
2984fc00	160
be1bb235	161	static int max77686_i2c_probe(struct i2c_client *i2c)
dae8a969	162	{
c1516f84	163	struct max77686_dev *max77686 = NULL;
dae8a969 JL	164	unsigned int data;
dae8a969 JL	165	int ret = 0;
a259f389 JMC	166	const struct regmap_config *config;
a259f389 JMC	167	const struct regmap_irq_chip *irq_chip;
a259f389 JMC	168	const struct mfd_cell *cells;
a259f389 JMC	169	int n_devs;
dae8a969	170
742413a4 LJ	171	max77686 = devm_kzalloc(&i2c->dev,
742413a4 LJ	172	sizeof(struct max77686_dev), GFP_KERNEL);
c0e0fcda	173	if (!max77686)
dae8a969 JL	174	return -ENOMEM;
dae8a969 JL	175
dae8a969	176	i2c_set_clientdata(i2c, max77686);
68e61f75	177	max77686->type = (unsigned long)of_device_get_match_data(&i2c->dev);
dae8a969 JL	178	max77686->dev = &i2c->dev;
dae8a969 JL	179	max77686->i2c = i2c;
dae8a969	180
2b40459b	181	max77686->irq = i2c->irq;
dae8a969	182
a259f389 JMC	183	if (max77686->type == TYPE_MAX77686) {
	184	config = &max77686_regmap_config;
	185	irq_chip = &max77686_irq_chip;
a259f389 JMC	186	cells = max77686_devs;
	187	n_devs = ARRAY_SIZE(max77686_devs);
	188	} else {
	189	config = &max77802_regmap_config;
	190	irq_chip = &max77802_irq_chip;
a259f389 JMC	191	cells = max77802_devs;
	192	n_devs = ARRAY_SIZE(max77802_devs);
	193	}
	194
	195	max77686->regmap = devm_regmap_init_i2c(i2c, config);
136d982e AL	196	if (IS_ERR(max77686->regmap)) {
	197	ret = PTR_ERR(max77686->regmap);
	198	dev_err(max77686->dev, "Failed to allocate register map: %d\n",
	199	ret);
136d982e AL	200	return ret;
	201	}
	202
c0e0fcda JMC	203	ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
c0e0fcda JMC	204	if (ret < 0) {
dae8a969 JL	205	dev_err(max77686->dev,
dae8a969 JL	206	"device not found on this channel (this is not an error)\n");
742413a4	207	return -ENODEV;
6f1c1e71	208	}
dae8a969	209
1a5422c9 LD	210	ret = devm_regmap_add_irq_chip(&i2c->dev, max77686->regmap,
	211	max77686->irq,
	212	IRQF_TRIGGER_FALLING \| IRQF_ONESHOT \|
	213	IRQF_SHARED, 0, irq_chip,
	214	&max77686->irq_data);
f3937549	215	if (ret < 0) {
6f1c1e71	216	dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
f3937549	217	return ret;
6f1c1e71	218	}
dae8a969	219
1a5422c9 LD	220	ret = devm_mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL,
1a5422c9 LD	221	0, NULL);
742413a4	222	if (ret < 0) {
6f1c1e71	223	dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
1a5422c9	224	return ret;
742413a4	225	}
dae8a969	226
dae8a969 JL	227	return 0;
	228	}
	229
2b52b5d5 JMC	230	#ifdef CONFIG_PM_SLEEP
	231	static int max77686_suspend(struct device *dev)
	232	{
1b5420e1	233	struct i2c_client *i2c = to_i2c_client(dev);
2b52b5d5 JMC	234	struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
	235
	236	if (device_may_wakeup(dev))
	237	enable_irq_wake(max77686->irq);
	238
	239	/*
	240	* IRQ must be disabled during suspend because if it happens
	241	* while suspended it will be handled before resuming I2C.
	242	*
	243	* When device is woken up from suspend (e.g. by RTC wake alarm),
	244	* an interrupt occurs before resuming I2C bus controller.
	245	* Interrupt handler tries to read registers but this read
	246	* will fail because I2C is still suspended.
	247	*/
	248	disable_irq(max77686->irq);
	249
	250	return 0;
	251	}
	252
	253	static int max77686_resume(struct device *dev)
	254	{
1b5420e1	255	struct i2c_client *i2c = to_i2c_client(dev);
2b52b5d5 JMC	256	struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
	257
	258	if (device_may_wakeup(dev))
	259	disable_irq_wake(max77686->irq);
	260
	261	enable_irq(max77686->irq);
	262
	263	return 0;
	264	}
	265	#endif /* CONFIG_PM_SLEEP */
	266
	267	static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);
	268
dae8a969 JL	269	static struct i2c_driver max77686_i2c_driver = {
	270	.driver = {
	271	.name = "max77686",
2b52b5d5	272	.pm = &max77686_pm,
c1516f84	273	.of_match_table = of_match_ptr(max77686_pmic_dt_match),
dae8a969	274	},
be1bb235	275	.probe_new = max77686_i2c_probe,
dae8a969 JL	276	};
dae8a969 JL	277
8a0aee4a	278	module_i2c_driver(max77686_i2c_driver);
dae8a969	279
a259f389	280	MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
dae8a969 JL	281	MODULE_AUTHOR("Chiwoong Byun <[email protected]>");
dae8a969 JL	282	MODULE_LICENSE("GPL");