[deliverable/linux.git] / drivers / mfd / max8997.c

/*
 * max8997.c - mfd core driver for the Maxim 8966 and 8997
 *
 * Copyright (C) 2011 Samsung Electronics
 * MyungJoo Ham <myungjoo.ham@smasung.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 max8998.c
 */

#include <linux/err.h>
#include <linux/slab.h>
#include <linux/i2c.h>
#include <linux/of.h>
#include <linux/of_irq.h>
#include <linux/interrupt.h>
#include <linux/pm_runtime.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/mfd/core.h>
#include <linux/mfd/max8997.h>
#include <linux/mfd/max8997-private.h>

#define I2C_ADDR_PMIC	(0xCC >> 1)
#define I2C_ADDR_MUIC	(0x4A >> 1)
#define I2C_ADDR_BATTERY	(0x6C >> 1)
#define I2C_ADDR_RTC	(0x0C >> 1)
#define I2C_ADDR_HAPTIC	(0x90 >> 1)

static const struct mfd_cell max8997_devs[] = {
	{ .name = "max8997-pmic", },
	{ .name = "max8997-rtc", },
	{ .name = "max8997-battery", },
	{ .name = "max8997-haptic", },
	{ .name = "max8997-muic", },
	{ .name = "max8997-led", .id = 1 },
	{ .name = "max8997-led", .id = 2 },
};

#ifdef CONFIG_OF
static struct of_device_id max8997_pmic_dt_match[] = {
	{ .compatible = "maxim,max8997-pmic", .data = (void *)TYPE_MAX8997 },
	{},
};
#endif

int max8997_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
{
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	int ret;

	mutex_lock(&max8997->iolock);
	ret = i2c_smbus_read_byte_data(i2c, reg);
	mutex_unlock(&max8997->iolock);
	if (ret < 0)
		return ret;

	ret &= 0xff;
	*dest = ret;
	return 0;
}
EXPORT_SYMBOL_GPL(max8997_read_reg);

int max8997_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
{
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	int ret;

	mutex_lock(&max8997->iolock);
	ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
	mutex_unlock(&max8997->iolock);
	if (ret < 0)
		return ret;

	return 0;
}
EXPORT_SYMBOL_GPL(max8997_bulk_read);

int max8997_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
{
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	int ret;

	mutex_lock(&max8997->iolock);
	ret = i2c_smbus_write_byte_data(i2c, reg, value);
	mutex_unlock(&max8997->iolock);
	return ret;
}
EXPORT_SYMBOL_GPL(max8997_write_reg);

int max8997_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
{
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	int ret;

	mutex_lock(&max8997->iolock);
	ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
	mutex_unlock(&max8997->iolock);
	if (ret < 0)
		return ret;

	return 0;
}
EXPORT_SYMBOL_GPL(max8997_bulk_write);

int max8997_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
{
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	int ret;

	mutex_lock(&max8997->iolock);
	ret = i2c_smbus_read_byte_data(i2c, reg);
	if (ret >= 0) {
		u8 old_val = ret & 0xff;
		u8 new_val = (val & mask) | (old_val & (~mask));
		ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
	}
	mutex_unlock(&max8997->iolock);
	return ret;
}
EXPORT_SYMBOL_GPL(max8997_update_reg);

/*
 * Only the common platform data elements for max8997 are parsed here from the
 * device tree. Other sub-modules of max8997 such as pmic, rtc and others have
 * to parse their own platform data elements from device tree.
 *
 * The max8997 platform data structure is instantiated here and the drivers for
 * the sub-modules need not instantiate another instance while parsing their
 * platform data.
 */
static struct max8997_platform_data *max8997_i2c_parse_dt_pdata(
					struct device *dev)
{
	struct max8997_platform_data *pd;

	pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
	if (!pd) {
		dev_err(dev, "could not allocate memory for pdata\n");
		return ERR_PTR(-ENOMEM);
	}

	pd->ono = irq_of_parse_and_map(dev->of_node, 1);

	/*
	 * ToDo: the 'wakeup' member in the platform data is more of a linux
	 * specfic information. Hence, there is no binding for that yet and
	 * not parsed here.
	 */

	return pd;
}

static inline unsigned long max8997_i2c_get_driver_data(struct i2c_client *i2c,
						const struct i2c_device_id *id)
{
	if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
		const struct of_device_id *match;
		match = of_match_node(max8997_pmic_dt_match, i2c->dev.of_node);
		return (unsigned long)match->data;
	}
	return id->driver_data;
}

static int max8997_i2c_probe(struct i2c_client *i2c,
			    const struct i2c_device_id *id)
{
	struct max8997_dev *max8997;
	struct max8997_platform_data *pdata = dev_get_platdata(&i2c->dev);
	int ret = 0;

	max8997 = devm_kzalloc(&i2c->dev, sizeof(struct max8997_dev),
				GFP_KERNEL);
	if (max8997 == NULL)
		return -ENOMEM;

	i2c_set_clientdata(i2c, max8997);
	max8997->dev = &i2c->dev;
	max8997->i2c = i2c;
	max8997->type = max8997_i2c_get_driver_data(i2c, id);
	max8997->irq = i2c->irq;

	if (IS_ENABLED(CONFIG_OF) && max8997->dev->of_node) {
		pdata = max8997_i2c_parse_dt_pdata(max8997->dev);
		if (IS_ERR(pdata))
			return PTR_ERR(pdata);
	}

	if (!pdata)
		return ret;

	max8997->pdata = pdata;
	max8997->ono = pdata->ono;

	mutex_init(&max8997->iolock);

	max8997->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
	i2c_set_clientdata(max8997->rtc, max8997);
	max8997->haptic = i2c_new_dummy(i2c->adapter, I2C_ADDR_HAPTIC);
	i2c_set_clientdata(max8997->haptic, max8997);
	max8997->muic = i2c_new_dummy(i2c->adapter, I2C_ADDR_MUIC);
	i2c_set_clientdata(max8997->muic, max8997);

	pm_runtime_set_active(max8997->dev);

	max8997_irq_init(max8997);

	ret = mfd_add_devices(max8997->dev, -1, max8997_devs,
			ARRAY_SIZE(max8997_devs),
			NULL, 0, NULL);
	if (ret < 0) {
		dev_err(max8997->dev, "failed to add MFD devices %d\n", ret);
		goto err_mfd;
	}

	/*
	 * TODO: enable others (flash, muic, rtc, battery, ...) and
	 * check the return value
	 */

	/* MAX8997 has a power button input. */
	device_init_wakeup(max8997->dev, pdata->wakeup);

	return ret;

err_mfd:
	mfd_remove_devices(max8997->dev);
	i2c_unregister_device(max8997->muic);
	i2c_unregister_device(max8997->haptic);
	i2c_unregister_device(max8997->rtc);
	return ret;
}

static int max8997_i2c_remove(struct i2c_client *i2c)
{
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);

	mfd_remove_devices(max8997->dev);
	i2c_unregister_device(max8997->muic);
	i2c_unregister_device(max8997->haptic);
	i2c_unregister_device(max8997->rtc);

	return 0;
}

static const struct i2c_device_id max8997_i2c_id[] = {
	{ "max8997", TYPE_MAX8997 },
	{ "max8966", TYPE_MAX8966 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, max8998_i2c_id);

static u8 max8997_dumpaddr_pmic[] = {
	MAX8997_REG_INT1MSK,
	MAX8997_REG_INT2MSK,
	MAX8997_REG_INT3MSK,
	MAX8997_REG_INT4MSK,
	MAX8997_REG_MAINCON1,
	MAX8997_REG_MAINCON2,
	MAX8997_REG_BUCKRAMP,
	MAX8997_REG_BUCK1CTRL,
	MAX8997_REG_BUCK1DVS1,
	MAX8997_REG_BUCK1DVS2,
	MAX8997_REG_BUCK1DVS3,
	MAX8997_REG_BUCK1DVS4,
	MAX8997_REG_BUCK1DVS5,
	MAX8997_REG_BUCK1DVS6,
	MAX8997_REG_BUCK1DVS7,
	MAX8997_REG_BUCK1DVS8,
	MAX8997_REG_BUCK2CTRL,
	MAX8997_REG_BUCK2DVS1,
	MAX8997_REG_BUCK2DVS2,
	MAX8997_REG_BUCK2DVS3,
	MAX8997_REG_BUCK2DVS4,
	MAX8997_REG_BUCK2DVS5,
	MAX8997_REG_BUCK2DVS6,
	MAX8997_REG_BUCK2DVS7,
	MAX8997_REG_BUCK2DVS8,
	MAX8997_REG_BUCK3CTRL,
	MAX8997_REG_BUCK3DVS,
	MAX8997_REG_BUCK4CTRL,
	MAX8997_REG_BUCK4DVS,
	MAX8997_REG_BUCK5CTRL,
	MAX8997_REG_BUCK5DVS1,
	MAX8997_REG_BUCK5DVS2,
	MAX8997_REG_BUCK5DVS3,
	MAX8997_REG_BUCK5DVS4,
	MAX8997_REG_BUCK5DVS5,
	MAX8997_REG_BUCK5DVS6,
	MAX8997_REG_BUCK5DVS7,
	MAX8997_REG_BUCK5DVS8,
	MAX8997_REG_BUCK6CTRL,
	MAX8997_REG_BUCK6BPSKIPCTRL,
	MAX8997_REG_BUCK7CTRL,
	MAX8997_REG_BUCK7DVS,
	MAX8997_REG_LDO1CTRL,
	MAX8997_REG_LDO2CTRL,
	MAX8997_REG_LDO3CTRL,
	MAX8997_REG_LDO4CTRL,
	MAX8997_REG_LDO5CTRL,
	MAX8997_REG_LDO6CTRL,
	MAX8997_REG_LDO7CTRL,
	MAX8997_REG_LDO8CTRL,
	MAX8997_REG_LDO9CTRL,
	MAX8997_REG_LDO10CTRL,
	MAX8997_REG_LDO11CTRL,
	MAX8997_REG_LDO12CTRL,
	MAX8997_REG_LDO13CTRL,
	MAX8997_REG_LDO14CTRL,
	MAX8997_REG_LDO15CTRL,
	MAX8997_REG_LDO16CTRL,
	MAX8997_REG_LDO17CTRL,
	MAX8997_REG_LDO18CTRL,
	MAX8997_REG_LDO21CTRL,
	MAX8997_REG_MBCCTRL1,
	MAX8997_REG_MBCCTRL2,
	MAX8997_REG_MBCCTRL3,
	MAX8997_REG_MBCCTRL4,
	MAX8997_REG_MBCCTRL5,
	MAX8997_REG_MBCCTRL6,
	MAX8997_REG_OTPCGHCVS,
	MAX8997_REG_SAFEOUTCTRL,
	MAX8997_REG_LBCNFG1,
	MAX8997_REG_LBCNFG2,
	MAX8997_REG_BBCCTRL,

	MAX8997_REG_FLASH1_CUR,
	MAX8997_REG_FLASH2_CUR,
	MAX8997_REG_MOVIE_CUR,
	MAX8997_REG_GSMB_CUR,
	MAX8997_REG_BOOST_CNTL,
	MAX8997_REG_LEN_CNTL,
	MAX8997_REG_FLASH_CNTL,
	MAX8997_REG_WDT_CNTL,
	MAX8997_REG_MAXFLASH1,
	MAX8997_REG_MAXFLASH2,
	MAX8997_REG_FLASHSTATUSMASK,

	MAX8997_REG_GPIOCNTL1,
	MAX8997_REG_GPIOCNTL2,
	MAX8997_REG_GPIOCNTL3,
	MAX8997_REG_GPIOCNTL4,
	MAX8997_REG_GPIOCNTL5,
	MAX8997_REG_GPIOCNTL6,
	MAX8997_REG_GPIOCNTL7,
	MAX8997_REG_GPIOCNTL8,
	MAX8997_REG_GPIOCNTL9,
	MAX8997_REG_GPIOCNTL10,
	MAX8997_REG_GPIOCNTL11,
	MAX8997_REG_GPIOCNTL12,

	MAX8997_REG_LDO1CONFIG,
	MAX8997_REG_LDO2CONFIG,
	MAX8997_REG_LDO3CONFIG,
	MAX8997_REG_LDO4CONFIG,
	MAX8997_REG_LDO5CONFIG,
	MAX8997_REG_LDO6CONFIG,
	MAX8997_REG_LDO7CONFIG,
	MAX8997_REG_LDO8CONFIG,
	MAX8997_REG_LDO9CONFIG,
	MAX8997_REG_LDO10CONFIG,
	MAX8997_REG_LDO11CONFIG,
	MAX8997_REG_LDO12CONFIG,
	MAX8997_REG_LDO13CONFIG,
	MAX8997_REG_LDO14CONFIG,
	MAX8997_REG_LDO15CONFIG,
	MAX8997_REG_LDO16CONFIG,
	MAX8997_REG_LDO17CONFIG,
	MAX8997_REG_LDO18CONFIG,
	MAX8997_REG_LDO21CONFIG,

	MAX8997_REG_DVSOKTIMER1,
	MAX8997_REG_DVSOKTIMER2,
	MAX8997_REG_DVSOKTIMER4,
	MAX8997_REG_DVSOKTIMER5,
};

static u8 max8997_dumpaddr_muic[] = {
	MAX8997_MUIC_REG_INTMASK1,
	MAX8997_MUIC_REG_INTMASK2,
	MAX8997_MUIC_REG_INTMASK3,
	MAX8997_MUIC_REG_CDETCTRL,
	MAX8997_MUIC_REG_CONTROL1,
	MAX8997_MUIC_REG_CONTROL2,
	MAX8997_MUIC_REG_CONTROL3,
};

static u8 max8997_dumpaddr_haptic[] = {
	MAX8997_HAPTIC_REG_CONF1,
	MAX8997_HAPTIC_REG_CONF2,
	MAX8997_HAPTIC_REG_DRVCONF,
	MAX8997_HAPTIC_REG_CYCLECONF1,
	MAX8997_HAPTIC_REG_CYCLECONF2,
	MAX8997_HAPTIC_REG_SIGCONF1,
	MAX8997_HAPTIC_REG_SIGCONF2,
	MAX8997_HAPTIC_REG_SIGCONF3,
	MAX8997_HAPTIC_REG_SIGCONF4,
	MAX8997_HAPTIC_REG_SIGDC1,
	MAX8997_HAPTIC_REG_SIGDC2,
	MAX8997_HAPTIC_REG_SIGPWMDC1,
	MAX8997_HAPTIC_REG_SIGPWMDC2,
	MAX8997_HAPTIC_REG_SIGPWMDC3,
	MAX8997_HAPTIC_REG_SIGPWMDC4,
};

static int max8997_freeze(struct device *dev)
{
	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	int i;

	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
		max8997_read_reg(i2c, max8997_dumpaddr_pmic[i],
				&max8997->reg_dump[i]);

	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
		max8997_read_reg(i2c, max8997_dumpaddr_muic[i],
				&max8997->reg_dump[i + MAX8997_REG_PMIC_END]);

	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
		max8997_read_reg(i2c, max8997_dumpaddr_haptic[i],
				&max8997->reg_dump[i + MAX8997_REG_PMIC_END +
				MAX8997_MUIC_REG_END]);

	return 0;
}

static int max8997_restore(struct device *dev)
{
	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	int i;

	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
		max8997_write_reg(i2c, max8997_dumpaddr_pmic[i],
				max8997->reg_dump[i]);

	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
		max8997_write_reg(i2c, max8997_dumpaddr_muic[i],
				max8997->reg_dump[i + MAX8997_REG_PMIC_END]);

	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
		max8997_write_reg(i2c, max8997_dumpaddr_haptic[i],
				max8997->reg_dump[i + MAX8997_REG_PMIC_END +
				MAX8997_MUIC_REG_END]);

	return 0;
}

static int max8997_suspend(struct device *dev)
{
	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);

	if (device_may_wakeup(dev))
		irq_set_irq_wake(max8997->irq, 1);
	return 0;
}

static int max8997_resume(struct device *dev)
{
	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);

	if (device_may_wakeup(dev))
		irq_set_irq_wake(max8997->irq, 0);
	return max8997_irq_resume(max8997);
}

static const struct dev_pm_ops max8997_pm = {
	.suspend = max8997_suspend,
	.resume = max8997_resume,
	.freeze = max8997_freeze,
	.restore = max8997_restore,
};

static struct i2c_driver max8997_i2c_driver = {
	.driver = {
		   .name = "max8997",
		   .owner = THIS_MODULE,
		   .pm = &max8997_pm,
		   .of_match_table = of_match_ptr(max8997_pmic_dt_match),
	},
	.probe = max8997_i2c_probe,
	.remove = max8997_i2c_remove,
	.id_table = max8997_i2c_id,
};

static int __init max8997_i2c_init(void)
{
	return i2c_add_driver(&max8997_i2c_driver);
}
/* init early so consumer devices can complete system boot */
subsys_initcall(max8997_i2c_init);

static void __exit max8997_i2c_exit(void)
{
	i2c_del_driver(&max8997_i2c_driver);
}
module_exit(max8997_i2c_exit);

MODULE_DESCRIPTION("MAXIM 8997 multi-function core driver");
MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
527e7e9a MH	1	/*
	2	* max8997.c - mfd core driver for the Maxim 8966 and 8997
	3	*
	4	* Copyright (C) 2011 Samsung Electronics
	5	* MyungJoo Ham <myungjoo.ham@smasung.com>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	20	*
	21	* This driver is based on max8998.c
	22	*/
	23
77b71b37	24	#include <linux/err.h>
527e7e9a MH	25	#include <linux/slab.h>
527e7e9a MH	26	#include <linux/i2c.h>
fb7d4a53	27	#include <linux/of.h>
77b71b37	28	#include <linux/of_irq.h>
01fdaab8	29	#include <linux/interrupt.h>
527e7e9a	30	#include <linux/pm_runtime.h>
4e36dd33	31	#include <linux/module.h>
527e7e9a MH	32	#include <linux/mutex.h>
	33	#include <linux/mfd/core.h>
	34	#include <linux/mfd/max8997.h>
	35	#include <linux/mfd/max8997-private.h>
	36
	37	#define I2C_ADDR_PMIC (0xCC >> 1)
	38	#define I2C_ADDR_MUIC (0x4A >> 1)
	39	#define I2C_ADDR_BATTERY (0x6C >> 1)
	40	#define I2C_ADDR_RTC (0x0C >> 1)
	41	#define I2C_ADDR_HAPTIC (0x90 >> 1)
	42
7c0517b1	43	static const struct mfd_cell max8997_devs[] = {
527e7e9a MH	44	{ .name = "max8997-pmic", },
	45	{ .name = "max8997-rtc", },
	46	{ .name = "max8997-battery", },
	47	{ .name = "max8997-haptic", },
	48	{ .name = "max8997-muic", },
f6dd2db9 DK	49	{ .name = "max8997-led", .id = 1 },
f6dd2db9 DK	50	{ .name = "max8997-led", .id = 2 },
527e7e9a MH	51	};
527e7e9a MH	52
77b71b37	53	#ifdef CONFIG_OF
612b95cd	54	static struct of_device_id max8997_pmic_dt_match[] = {
ed6ccdc6	55	{ .compatible = "maxim,max8997-pmic", .data = (void *)TYPE_MAX8997 },
77b71b37 TA	56	{},
	57	};
	58	#endif
	59
527e7e9a MH	60	int max8997_read_reg(struct i2c_client i2c, u8 reg, u8 dest)
	61	{
	62	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	63	int ret;
	64
	65	mutex_lock(&max8997->iolock);
	66	ret = i2c_smbus_read_byte_data(i2c, reg);
	67	mutex_unlock(&max8997->iolock);
	68	if (ret < 0)
	69	return ret;
	70
	71	ret &= 0xff;
	72	*dest = ret;
	73	return 0;
	74	}
	75	EXPORT_SYMBOL_GPL(max8997_read_reg);
	76
	77	int max8997_bulk_read(struct i2c_client i2c, u8 reg, int count, u8 buf)
	78	{
	79	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	80	int ret;
	81
	82	mutex_lock(&max8997->iolock);
	83	ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
	84	mutex_unlock(&max8997->iolock);
	85	if (ret < 0)
	86	return ret;
	87
	88	return 0;
	89	}
	90	EXPORT_SYMBOL_GPL(max8997_bulk_read);
	91
	92	int max8997_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
	93	{
	94	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	95	int ret;
	96
	97	mutex_lock(&max8997->iolock);
	98	ret = i2c_smbus_write_byte_data(i2c, reg, value);
	99	mutex_unlock(&max8997->iolock);
	100	return ret;
	101	}
	102	EXPORT_SYMBOL_GPL(max8997_write_reg);
	103
	104	int max8997_bulk_write(struct i2c_client i2c, u8 reg, int count, u8 buf)
	105	{
	106	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	107	int ret;
	108
	109	mutex_lock(&max8997->iolock);
	110	ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
	111	mutex_unlock(&max8997->iolock);
	112	if (ret < 0)
	113	return ret;
	114
	115	return 0;
	116	}
	117	EXPORT_SYMBOL_GPL(max8997_bulk_write);
	118
	119	int max8997_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
	120	{
	121	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	122	int ret;
	123
124	mutex_lock(&max8997->iolock);
125	ret = i2c_smbus_read_byte_data(i2c, reg);
126	if (ret >= 0) {
127	u8 old_val = ret & 0xff;
128	u8 new_val = (val & mask) \| (old_val & (~mask));
129	ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
130	}
131	mutex_unlock(&max8997->iolock);
132	return ret;
133	}
134	EXPORT_SYMBOL_GPL(max8997_update_reg);
135
77b71b37 TA	136	/*
	137	* Only the common platform data elements for max8997 are parsed here from the
	138	* device tree. Other sub-modules of max8997 such as pmic, rtc and others have
	139	* to parse their own platform data elements from device tree.
	140	*
	141	* The max8997 platform data structure is instantiated here and the drivers for
	142	* the sub-modules need not instantiate another instance while parsing their
	143	* platform data.
	144	*/
	145	static struct max8997_platform_data *max8997_i2c_parse_dt_pdata(
	146	struct device *dev)
	147	{
	148	struct max8997_platform_data *pd;
	149
	150	pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
	151	if (!pd) {
	152	dev_err(dev, "could not allocate memory for pdata\n");
	153	return ERR_PTR(-ENOMEM);
	154	}
	155
	156	pd->ono = irq_of_parse_and_map(dev->of_node, 1);
	157
	158	/*
	159	* ToDo: the 'wakeup' member in the platform data is more of a linux
	160	* specfic information. Hence, there is no binding for that yet and
	161	* not parsed here.
	162	*/
	163
	164	return pd;
	165	}
77b71b37	166
05fb7a56	167	static inline unsigned long max8997_i2c_get_driver_data(struct i2c_client *i2c,
77b71b37 TA	168	const struct i2c_device_id *id)
77b71b37 TA	169	{
01c3f110	170	if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
77b71b37 TA	171	const struct of_device_id *match;
77b71b37 TA	172	match = of_match_node(max8997_pmic_dt_match, i2c->dev.of_node);
05fb7a56	173	return (unsigned long)match->data;
77b71b37	174	}
05fb7a56	175	return id->driver_data;
77b71b37 TA	176	}
77b71b37 TA	177
527e7e9a MH	178	static int max8997_i2c_probe(struct i2c_client *i2c,
	179	const struct i2c_device_id *id)
	180	{
	181	struct max8997_dev *max8997;
334a41ce	182	struct max8997_platform_data *pdata = dev_get_platdata(&i2c->dev);
527e7e9a MH	183	int ret = 0;
527e7e9a MH	184
6922ffcf JH	185	max8997 = devm_kzalloc(&i2c->dev, sizeof(struct max8997_dev),
6922ffcf JH	186	GFP_KERNEL);
527e7e9a MH	187	if (max8997 == NULL)
	188	return -ENOMEM;
	189
	190	i2c_set_clientdata(i2c, max8997);
	191	max8997->dev = &i2c->dev;
	192	max8997->i2c = i2c;
77b71b37	193	max8997->type = max8997_i2c_get_driver_data(i2c, id);
7eb3154e	194	max8997->irq = i2c->irq;
527e7e9a	195
01c3f110	196	if (IS_ENABLED(CONFIG_OF) && max8997->dev->of_node) {
77b71b37	197	pdata = max8997_i2c_parse_dt_pdata(max8997->dev);
6922ffcf JH	198	if (IS_ERR(pdata))
6922ffcf JH	199	return PTR_ERR(pdata);
77b71b37 TA	200	}
77b71b37 TA	201
527e7e9a	202	if (!pdata)
6922ffcf	203	return ret;
527e7e9a	204
77b71b37	205	max8997->pdata = pdata;
7eb3154e	206	max8997->ono = pdata->ono;
527e7e9a MH	207
	208	mutex_init(&max8997->iolock);
	209
	210	max8997->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
	211	i2c_set_clientdata(max8997->rtc, max8997);
	212	max8997->haptic = i2c_new_dummy(i2c->adapter, I2C_ADDR_HAPTIC);
	213	i2c_set_clientdata(max8997->haptic, max8997);
	214	max8997->muic = i2c_new_dummy(i2c->adapter, I2C_ADDR_MUIC);
	215	i2c_set_clientdata(max8997->muic, max8997);
	216
	217	pm_runtime_set_active(max8997->dev);
	218
7eb3154e MH	219	max8997_irq_init(max8997);
7eb3154e MH	220
c1ec8fc3	221	ret = mfd_add_devices(max8997->dev, -1, max8997_devs,
527e7e9a	222	ARRAY_SIZE(max8997_devs),
0848c94f	223	NULL, 0, NULL);
c1ec8fc3 LP	224	if (ret < 0) {
	225	dev_err(max8997->dev, "failed to add MFD devices %d\n", ret);
	226	goto err_mfd;
	227	}
527e7e9a MH	228
	229	/*
	230	* TODO: enable others (flash, muic, rtc, battery, ...) and
	231	* check the return value
	232	*/
	233
01fdaab8 MH	234	/* MAX8997 has a power button input. */
	235	device_init_wakeup(max8997->dev, pdata->wakeup);
	236
527e7e9a MH	237	return ret;
	238
	239	err_mfd:
	240	mfd_remove_devices(max8997->dev);
	241	i2c_unregister_device(max8997->muic);
	242	i2c_unregister_device(max8997->haptic);
	243	i2c_unregister_device(max8997->rtc);
527e7e9a MH	244	return ret;
	245	}
	246
	247	static int max8997_i2c_remove(struct i2c_client *i2c)
	248	{
	249	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	250
	251	mfd_remove_devices(max8997->dev);
	252	i2c_unregister_device(max8997->muic);
	253	i2c_unregister_device(max8997->haptic);
	254	i2c_unregister_device(max8997->rtc);
527e7e9a MH	255
	256	return 0;
	257	}
	258
	259	static const struct i2c_device_id max8997_i2c_id[] = {
	260	{ "max8997", TYPE_MAX8997 },
	261	{ "max8966", TYPE_MAX8966 },
	262	{ }
	263	};
	264	MODULE_DEVICE_TABLE(i2c, max8998_i2c_id);
	265
b673e24c	266	static u8 max8997_dumpaddr_pmic[] = {
527e7e9a MH	267	MAX8997_REG_INT1MSK,
	268	MAX8997_REG_INT2MSK,
	269	MAX8997_REG_INT3MSK,
	270	MAX8997_REG_INT4MSK,
	271	MAX8997_REG_MAINCON1,
	272	MAX8997_REG_MAINCON2,
	273	MAX8997_REG_BUCKRAMP,
	274	MAX8997_REG_BUCK1CTRL,
	275	MAX8997_REG_BUCK1DVS1,
	276	MAX8997_REG_BUCK1DVS2,
	277	MAX8997_REG_BUCK1DVS3,
	278	MAX8997_REG_BUCK1DVS4,
	279	MAX8997_REG_BUCK1DVS5,
	280	MAX8997_REG_BUCK1DVS6,
	281	MAX8997_REG_BUCK1DVS7,
	282	MAX8997_REG_BUCK1DVS8,
	283	MAX8997_REG_BUCK2CTRL,
	284	MAX8997_REG_BUCK2DVS1,
	285	MAX8997_REG_BUCK2DVS2,
	286	MAX8997_REG_BUCK2DVS3,
	287	MAX8997_REG_BUCK2DVS4,
	288	MAX8997_REG_BUCK2DVS5,
	289	MAX8997_REG_BUCK2DVS6,
	290	MAX8997_REG_BUCK2DVS7,
	291	MAX8997_REG_BUCK2DVS8,
	292	MAX8997_REG_BUCK3CTRL,
	293	MAX8997_REG_BUCK3DVS,
	294	MAX8997_REG_BUCK4CTRL,
	295	MAX8997_REG_BUCK4DVS,
	296	MAX8997_REG_BUCK5CTRL,
	297	MAX8997_REG_BUCK5DVS1,
	298	MAX8997_REG_BUCK5DVS2,
	299	MAX8997_REG_BUCK5DVS3,
	300	MAX8997_REG_BUCK5DVS4,
	301	MAX8997_REG_BUCK5DVS5,
	302	MAX8997_REG_BUCK5DVS6,
	303	MAX8997_REG_BUCK5DVS7,
	304	MAX8997_REG_BUCK5DVS8,
	305	MAX8997_REG_BUCK6CTRL,
	306	MAX8997_REG_BUCK6BPSKIPCTRL,
	307	MAX8997_REG_BUCK7CTRL,
	308	MAX8997_REG_BUCK7DVS,
	309	MAX8997_REG_LDO1CTRL,
	310	MAX8997_REG_LDO2CTRL,
	311	MAX8997_REG_LDO3CTRL,
	312	MAX8997_REG_LDO4CTRL,
	313	MAX8997_REG_LDO5CTRL,
	314	MAX8997_REG_LDO6CTRL,
	315	MAX8997_REG_LDO7CTRL,
	316	MAX8997_REG_LDO8CTRL,
	317	MAX8997_REG_LDO9CTRL,
	318	MAX8997_REG_LDO10CTRL,
	319	MAX8997_REG_LDO11CTRL,
	320	MAX8997_REG_LDO12CTRL,
	321	MAX8997_REG_LDO13CTRL,
	322	MAX8997_REG_LDO14CTRL,
	323	MAX8997_REG_LDO15CTRL,
	324	MAX8997_REG_LDO16CTRL,
	325	MAX8997_REG_LDO17CTRL,
	326	MAX8997_REG_LDO18CTRL,
	327	MAX8997_REG_LDO21CTRL,
	328	MAX8997_REG_MBCCTRL1,
	329	MAX8997_REG_MBCCTRL2,
	330	MAX8997_REG_MBCCTRL3,
331	MAX8997_REG_MBCCTRL4,
332	MAX8997_REG_MBCCTRL5,
333	MAX8997_REG_MBCCTRL6,
334	MAX8997_REG_OTPCGHCVS,
335	MAX8997_REG_SAFEOUTCTRL,
336	MAX8997_REG_LBCNFG1,
337	MAX8997_REG_LBCNFG2,
338	MAX8997_REG_BBCCTRL,
339
340	MAX8997_REG_FLASH1_CUR,
341	MAX8997_REG_FLASH2_CUR,
342	MAX8997_REG_MOVIE_CUR,
343	MAX8997_REG_GSMB_CUR,
344	MAX8997_REG_BOOST_CNTL,
345	MAX8997_REG_LEN_CNTL,
346	MAX8997_REG_FLASH_CNTL,
347	MAX8997_REG_WDT_CNTL,
348	MAX8997_REG_MAXFLASH1,
349	MAX8997_REG_MAXFLASH2,
350	MAX8997_REG_FLASHSTATUSMASK,
351
352	MAX8997_REG_GPIOCNTL1,
353	MAX8997_REG_GPIOCNTL2,
354	MAX8997_REG_GPIOCNTL3,
355	MAX8997_REG_GPIOCNTL4,
356	MAX8997_REG_GPIOCNTL5,
357	MAX8997_REG_GPIOCNTL6,
358	MAX8997_REG_GPIOCNTL7,
359	MAX8997_REG_GPIOCNTL8,
360	MAX8997_REG_GPIOCNTL9,
361	MAX8997_REG_GPIOCNTL10,
362	MAX8997_REG_GPIOCNTL11,
363	MAX8997_REG_GPIOCNTL12,
364
365	MAX8997_REG_LDO1CONFIG,
366	MAX8997_REG_LDO2CONFIG,
367	MAX8997_REG_LDO3CONFIG,
368	MAX8997_REG_LDO4CONFIG,
369	MAX8997_REG_LDO5CONFIG,
370	MAX8997_REG_LDO6CONFIG,
371	MAX8997_REG_LDO7CONFIG,
372	MAX8997_REG_LDO8CONFIG,
373	MAX8997_REG_LDO9CONFIG,
374	MAX8997_REG_LDO10CONFIG,
375	MAX8997_REG_LDO11CONFIG,
376	MAX8997_REG_LDO12CONFIG,
377	MAX8997_REG_LDO13CONFIG,
378	MAX8997_REG_LDO14CONFIG,
379	MAX8997_REG_LDO15CONFIG,
380	MAX8997_REG_LDO16CONFIG,
381	MAX8997_REG_LDO17CONFIG,
382	MAX8997_REG_LDO18CONFIG,
383	MAX8997_REG_LDO21CONFIG,
384
385	MAX8997_REG_DVSOKTIMER1,
386	MAX8997_REG_DVSOKTIMER2,
387	MAX8997_REG_DVSOKTIMER4,
388	MAX8997_REG_DVSOKTIMER5,
389	};
390
b673e24c	391	static u8 max8997_dumpaddr_muic[] = {
527e7e9a MH	392	MAX8997_MUIC_REG_INTMASK1,
	393	MAX8997_MUIC_REG_INTMASK2,
	394	MAX8997_MUIC_REG_INTMASK3,
	395	MAX8997_MUIC_REG_CDETCTRL,
	396	MAX8997_MUIC_REG_CONTROL1,
	397	MAX8997_MUIC_REG_CONTROL2,
	398	MAX8997_MUIC_REG_CONTROL3,
	399	};
	400
b673e24c	401	static u8 max8997_dumpaddr_haptic[] = {
527e7e9a MH	402	MAX8997_HAPTIC_REG_CONF1,
	403	MAX8997_HAPTIC_REG_CONF2,
	404	MAX8997_HAPTIC_REG_DRVCONF,
	405	MAX8997_HAPTIC_REG_CYCLECONF1,
	406	MAX8997_HAPTIC_REG_CYCLECONF2,
	407	MAX8997_HAPTIC_REG_SIGCONF1,
	408	MAX8997_HAPTIC_REG_SIGCONF2,
	409	MAX8997_HAPTIC_REG_SIGCONF3,
	410	MAX8997_HAPTIC_REG_SIGCONF4,
	411	MAX8997_HAPTIC_REG_SIGDC1,
	412	MAX8997_HAPTIC_REG_SIGDC2,
	413	MAX8997_HAPTIC_REG_SIGPWMDC1,
	414	MAX8997_HAPTIC_REG_SIGPWMDC2,
	415	MAX8997_HAPTIC_REG_SIGPWMDC3,
	416	MAX8997_HAPTIC_REG_SIGPWMDC4,
	417	};
	418
	419	static int max8997_freeze(struct device *dev)
	420	{
	421	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
	422	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	423	int i;
	424
	425	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
	426	max8997_read_reg(i2c, max8997_dumpaddr_pmic[i],
	427	&max8997->reg_dump[i]);
	428
	429	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
	430	max8997_read_reg(i2c, max8997_dumpaddr_muic[i],
	431	&max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
	432
	433	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
	434	max8997_read_reg(i2c, max8997_dumpaddr_haptic[i],
	435	&max8997->reg_dump[i + MAX8997_REG_PMIC_END +
	436	MAX8997_MUIC_REG_END]);
	437
	438	return 0;
	439	}
	440
	441	static int max8997_restore(struct device *dev)
	442	{
	443	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
	444	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	445	int i;
	446
	447	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
	448	max8997_write_reg(i2c, max8997_dumpaddr_pmic[i],
	449	max8997->reg_dump[i]);
	450
	451	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
	452	max8997_write_reg(i2c, max8997_dumpaddr_muic[i],
	453	max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
	454
	455	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
	456	max8997_write_reg(i2c, max8997_dumpaddr_haptic[i],
	457	max8997->reg_dump[i + MAX8997_REG_PMIC_END +
	458	MAX8997_MUIC_REG_END]);
	459
	460	return 0;
	461	}
	462
01fdaab8 MH	463	static int max8997_suspend(struct device *dev)
	464	{
	465	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
	466	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	467
	468	if (device_may_wakeup(dev))
	469	irq_set_irq_wake(max8997->irq, 1);
	470	return 0;
	471	}
	472
	473	static int max8997_resume(struct device *dev)
	474	{
	475	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
	476	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
	477
	478	if (device_may_wakeup(dev))
	479	irq_set_irq_wake(max8997->irq, 0);
	480	return max8997_irq_resume(max8997);
	481	}
	482
b673e24c	483	static const struct dev_pm_ops max8997_pm = {
01fdaab8 MH	484	.suspend = max8997_suspend,
01fdaab8 MH	485	.resume = max8997_resume,
527e7e9a MH	486	.freeze = max8997_freeze,
	487	.restore = max8997_restore,
	488	};
	489
	490	static struct i2c_driver max8997_i2c_driver = {
	491	.driver = {
	492	.name = "max8997",
	493	.owner = THIS_MODULE,
	494	.pm = &max8997_pm,
77b71b37	495	.of_match_table = of_match_ptr(max8997_pmic_dt_match),
527e7e9a MH	496	},
	497	.probe = max8997_i2c_probe,
	498	.remove = max8997_i2c_remove,
	499	.id_table = max8997_i2c_id,
	500	};
	501
	502	static int __init max8997_i2c_init(void)
	503	{
	504	return i2c_add_driver(&max8997_i2c_driver);
	505	}
	506	/* init early so consumer devices can complete system boot */
	507	subsys_initcall(max8997_i2c_init);
	508
	509	static void __exit max8997_i2c_exit(void)
	510	{
	511	i2c_del_driver(&max8997_i2c_driver);
	512	}
	513	module_exit(max8997_i2c_exit);
	514
	515	MODULE_DESCRIPTION("MAXIM 8997 multi-function core driver");
	516	MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
	517	MODULE_LICENSE("GPL");