mfd: MAX8997/8966 support

MAX8997/MAX8966 chip is a multi-function device with I2C bussses. The
chip includes PMIC, RTC, Fuel Gauge, MUIC, Haptic, Flash control, and
Battery (charging) control.

This patch is an initial release of a MAX8997/8966 driver that supports
to enable the chip with its primary I2C bus that connects every device
mentioned above except for Fuel Gauge, which uses another I2C bus. The
fuel gauge is not supported by this mfd driver and is supported by a
seperated driver of MAX17042 Fuel Gauge (yes, the fuel gauge part is
compatible with MAX17042).

Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com>
Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com>
Reviewed-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>

3 files changed, 440 insertions, 0 deletions

diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
index 50c476964e48..642168c8d3b1 100644
--- a/drivers/mfd/Kconfig
+++ b/drivers/mfd/Kconfig
@@ -314,6 +314,18 @@ config MFD_MAX8925
           accessing the device, additional drivers must be enabled in order
           to use the functionality of the device.
 
+config MFD_MAX8997
+        bool "Maxim Semiconductor MAX8997/8966 PMIC Support"
+        depends on I2C=y && GENERIC_HARDIRQS
+        select MFD_CORE
+        help
+          Say yes here to support for Maxim Semiconductor MAX8998/8966.
+          This is a Power Management IC with RTC, Flash, Fuel Gauge, Haptic,
+          MUIC controls on chip.
+          This driver provies common support for accessing the device,
+          additional drivers must be enabled in order to use the functionality
+          of the device.
+
 config MFD_MAX8998
         bool "Maxim Semiconductor MAX8998/National LP3974 PMIC Support"
         depends on I2C=y && GENERIC_HARDIRQS
diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
index 25f3c7551489..0e9f0c51449d 100644
--- a/drivers/mfd/Makefile
+++ b/drivers/mfd/Makefile
@@ -62,6 +62,7 @@ obj-$(CONFIG_UCB1400_CORE)	+= ucb1400_core.o
 obj-$(CONFIG_PMIC_DA903X)       += da903x.o
 max8925-objs                    := max8925-core.o max8925-i2c.o
 obj-$(CONFIG_MFD_MAX8925)       += max8925.o
+obj-$(CONFIG_MFD_MAX8997)       += max8997.o
 obj-$(CONFIG_MFD_MAX8998)       += max8998.o max8998-irq.o
 
 pcf50633-objs                   := pcf50633-core.o pcf50633-irq.o
diff --git a/drivers/mfd/max8997.c b/drivers/mfd/max8997.c
new file mode 100644
index 000000000000..5d1fca0277ef
--- /dev/null
+++ b/drivers/mfd/max8997.c
@@ -0,0 +1,427 @@
+/*
+ * 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/slab.h>
+#include <linux/i2c.h>
+#include <linux/pm_runtime.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 struct mfd_cell max8997_devs[] = {
+        { .name = "max8997-pmic", },
+        { .name = "max8997-rtc", },
+        { .name = "max8997-battery", },
+        { .name = "max8997-haptic", },
+        { .name = "max8997-muic", },
+        { .name = "max8997-flash", },
+};
+
+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);
+
+static int max8997_i2c_probe(struct i2c_client *i2c,
+                            const struct i2c_device_id *id)
+{
+        struct max8997_dev *max8997;
+        struct max8997_platform_data *pdata = i2c->dev.platform_data;
+        int ret = 0;
+
+        max8997 = kzalloc(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 = id->driver_data;
+
+        if (!pdata)
+                goto err;
+
+        max8997->wakeup = pdata->wakeup;
+
+        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);
+
+        mfd_add_devices(max8997->dev, -1, max8997_devs,
+                        ARRAY_SIZE(max8997_devs),
+                        NULL, 0);
+
+        /*
+         * TODO: enable others (flash, muic, rtc, battery, ...) and
+         * check the return value
+         */
+
+        if (ret < 0)
+                goto err_mfd;
+
+        return ret;
+
+err_mfd:
+        mfd_remove_devices(max8997->dev);
+        i2c_unregister_device(max8997->muic);
+        i2c_unregister_device(max8997->haptic);
+        i2c_unregister_device(max8997->rtc);
+err:
+        kfree(max8997);
+        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);
+        kfree(max8997);
+
+        return 0;
+}
+
+static const struct i2c_device_id max8997_i2c_id[] = {
+        { "max8997", TYPE_MAX8997 },
+        { "max8966", TYPE_MAX8966 },
+        { }
+};
+MODULE_DEVICE_TABLE(i2c, max8998_i2c_id);
+
+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,
+};
+
+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,
+};
+
+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;
+}
+
+const struct dev_pm_ops max8997_pm = {
+        .freeze = max8997_freeze,
+        .restore = max8997_restore,
+};
+
+static struct i2c_driver max8997_i2c_driver = {
+        .driver = {
+                   .name = "max8997",
+                   .owner = THIS_MODULE,
+                   .pm = &max8997_pm,
+        },
+        .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");