drivers/mfd/max8998.c

   1 /*
   2  * max8998.c - mfd core driver for the Maxim 8998
   3  *
   4  *  Copyright (C) 2009-2010 Samsung Electronics
   5  *  Kyungmin Park <kyungmin.park@samsung.com>
   6  *  Marek Szyprowski <m.szyprowski@samsung.com>
   7  *
   8  * This program is not provided / owned by Maxim Integrated Products.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 #include <linux/module.h>
  26 #include <linux/moduleparam.h>
  27 #include <linux/init.h>
  28 #include <linux/slab.h>
  29 #include <linux/i2c.h>
  30 #include <linux/interrupt.h>
  31 #include <linux/pm_runtime.h>
  32 #include <linux/mutex.h>
  33 #include <linux/mfd/core.h>
  34 #include <linux/mfd/max8998.h>
  35 #include <linux/mfd/max8998-private.h>
  36
  37 #define RTC_I2C_ADDR            (0x0c >> 1)
  38
  39 static struct mfd_cell max8998_devs[] = {
  40         {
  41                 .name = "max8998-pmic",
  42         }, {
  43                 .name = "max8998-rtc",
  44         }, {
  45                 .name = "max8998-battery",
  46         },
  47 };
  48
  49 static struct mfd_cell lp3974_devs[] = {
  50         {
  51                 .name = "lp3974-pmic",
  52         }, {
  53                 .name = "lp3974-rtc",
  54         }, {
  55                 .name = "lp3974-battery",
  56         },
  57 };
  58
  59 static struct mfd_cell lp3974_regerr_devs[] = {
  60         {
  61                 .name = "lp3974-pmic",
  62         }, {
  63                 .name = "lp3974-rtc-regerr",
  64         }, {
  65                 .name = "lp3974-battery",
  66         },
  67 };
  68
  69 int max8998_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
  70 {
  71         struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
  72         int ret;
  73
  74         mutex_lock(&max8998->iolock);
  75         ret = i2c_smbus_read_byte_data(i2c, reg);
  76         mutex_unlock(&max8998->iolock);
  77         if (ret < 0)
  78                 return ret;
  79
  80         ret &= 0xff;
  81         *dest = ret;
  82         return 0;
  83 }
  84 EXPORT_SYMBOL(max8998_read_reg);
  85
  86 int max8998_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
  87 {
  88         struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
  89         int ret;
  90
  91         mutex_lock(&max8998->iolock);
  92         ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
  93         mutex_unlock(&max8998->iolock);
  94         if (ret < 0)
  95                 return ret;
  96
  97         return 0;
  98 }
  99 EXPORT_SYMBOL(max8998_bulk_read);
 100
 101 int max8998_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
 102 {
 103         struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
 104         int ret;
 105
 106         mutex_lock(&max8998->iolock);
 107         ret = i2c_smbus_write_byte_data(i2c, reg, value);
 108         mutex_unlock(&max8998->iolock);
 109         return ret;
 110 }
 111 EXPORT_SYMBOL(max8998_write_reg);
 112
 113 int max8998_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
 114 {
 115         struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
 116         int ret;
 117
 118         mutex_lock(&max8998->iolock);
 119         ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
 120         mutex_unlock(&max8998->iolock);
 121         if (ret < 0)
 122                 return ret;
 123
 124         return 0;
 125 }
 126 EXPORT_SYMBOL(max8998_bulk_write);
 127
 128 int max8998_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
 129 {
 130         struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
 131         int ret;
 132
 133         mutex_lock(&max8998->iolock);
 134         ret = i2c_smbus_read_byte_data(i2c, reg);
 135         if (ret >= 0) {
 136                 u8 old_val = ret & 0xff;
 137                 u8 new_val = (val & mask) | (old_val & (~mask));
 138                 ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
 139         }
 140         mutex_unlock(&max8998->iolock);
 141         return ret;
 142 }
 143 EXPORT_SYMBOL(max8998_update_reg);
 144
 145 static int max8998_i2c_probe(struct i2c_client *i2c,
 146                             const struct i2c_device_id *id)
 147 {
 148         struct max8998_platform_data *pdata = i2c->dev.platform_data;
 149         struct max8998_dev *max8998;
 150         int ret = 0;
 151
 152         max8998 = kzalloc(sizeof(struct max8998_dev), GFP_KERNEL);
 153         if (max8998 == NULL)
 154                 return -ENOMEM;
 155
 156         i2c_set_clientdata(i2c, max8998);
 157         max8998->dev = &i2c->dev;
 158         max8998->i2c = i2c;
 159         max8998->irq = i2c->irq;
 160         max8998->type = id->driver_data;
 161         if (pdata) {
 162                 max8998->ono = pdata->ono;
 163                 max8998->irq_base = pdata->irq_base;
 164                 max8998->wakeup = pdata->wakeup;
 165         }
 166         mutex_init(&max8998->iolock);
 167
 168         max8998->rtc = i2c_new_dummy(i2c->adapter, RTC_I2C_ADDR);
 169         i2c_set_clientdata(max8998->rtc, max8998);
 170
 171         max8998_irq_init(max8998);
 172
 173         pm_runtime_set_active(max8998->dev);
 174
 175         switch (id->driver_data) {
 176         case TYPE_LP3974_REGERR:
 177                 ret = mfd_add_devices(max8998->dev, -1,
 178                                 lp3974_regerr_devs,
 179                                 ARRAY_SIZE(lp3974_regerr_devs),
 180                                 NULL, 0);
 181                 break;
 182         case TYPE_LP3974:
 183                 ret = mfd_add_devices(max8998->dev, -1,
 184                                 lp3974_devs, ARRAY_SIZE(lp3974_devs),
 185                                 NULL, 0);
 186                 break;
 187         case TYPE_MAX8998:
 188                 ret = mfd_add_devices(max8998->dev, -1,
 189                                 max8998_devs, ARRAY_SIZE(max8998_devs),
 190                                 NULL, 0);
 191                 break;
 192         default:
 193                 ret = -EINVAL;
 194         }
 195
 196         if (ret < 0)
 197                 goto err;
 198
 199         return ret;
 200
 201 err:
 202         mfd_remove_devices(max8998->dev);
 203         max8998_irq_exit(max8998);
 204         i2c_unregister_device(max8998->rtc);
 205         kfree(max8998);
 206         return ret;
 207 }
 208
 209 static int max8998_i2c_remove(struct i2c_client *i2c)
 210 {
 211         struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
 212
 213         mfd_remove_devices(max8998->dev);
 214         max8998_irq_exit(max8998);
 215         i2c_unregister_device(max8998->rtc);
 216         kfree(max8998);
 217
 218         return 0;
 219 }
 220
 221 static const struct i2c_device_id max8998_i2c_id[] = {
 222         { "max8998", TYPE_MAX8998 },
 223         { "lp3974", TYPE_LP3974},
 224         { "lp3974-regerr", TYPE_LP3974_REGERR },
 225         { }
 226 };
 227 MODULE_DEVICE_TABLE(i2c, max8998_i2c_id);
 228
 229 static int max8998_suspend(struct device *dev)
 230 {
 231         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
 232         struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
 233
 234         if (max8998->wakeup)
 235                 set_irq_wake(max8998->irq, 1);
 236         return 0;
 237 }
 238
 239 static int max8998_resume(struct device *dev)
 240 {
 241         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
 242         struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
 243
 244         if (max8998->wakeup)
 245                 set_irq_wake(max8998->irq, 0);
 246         /*
 247          * In LP3974, if IRQ registers are not "read & clear"
 248          * when it's set during sleep, the interrupt becomes
 249          * disabled.
 250          */
 251         return max8998_irq_resume(i2c_get_clientdata(i2c));
 252 }
 253
 254 struct max8998_reg_dump {
 255         u8      addr;
 256         u8      val;
 257 };
 258 #define SAVE_ITEM(x)    { .addr = (x), .val = 0x0, }
 259 struct max8998_reg_dump max8998_dump[] = {
 260         SAVE_ITEM(MAX8998_REG_IRQM1),
 261         SAVE_ITEM(MAX8998_REG_IRQM2),
 262         SAVE_ITEM(MAX8998_REG_IRQM3),
 263         SAVE_ITEM(MAX8998_REG_IRQM4),
 264         SAVE_ITEM(MAX8998_REG_STATUSM1),
 265         SAVE_ITEM(MAX8998_REG_STATUSM2),
 266         SAVE_ITEM(MAX8998_REG_CHGR1),
 267         SAVE_ITEM(MAX8998_REG_CHGR2),
 268         SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
 269         SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
 270         SAVE_ITEM(MAX8998_REG_BUCK_ACTIVE_DISCHARGE3),
 271         SAVE_ITEM(MAX8998_REG_ONOFF1),
 272         SAVE_ITEM(MAX8998_REG_ONOFF2),
 273         SAVE_ITEM(MAX8998_REG_ONOFF3),
 274         SAVE_ITEM(MAX8998_REG_ONOFF4),
 275         SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE1),
 276         SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE2),
 277         SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE3),
 278         SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE4),
 279         SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE1),
 280         SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE2),
 281         SAVE_ITEM(MAX8998_REG_LDO2_LDO3),
 282         SAVE_ITEM(MAX8998_REG_LDO4),
 283         SAVE_ITEM(MAX8998_REG_LDO5),
 284         SAVE_ITEM(MAX8998_REG_LDO6),
 285         SAVE_ITEM(MAX8998_REG_LDO7),
 286         SAVE_ITEM(MAX8998_REG_LDO8_LDO9),
 287         SAVE_ITEM(MAX8998_REG_LDO10_LDO11),
 288         SAVE_ITEM(MAX8998_REG_LDO12),
 289         SAVE_ITEM(MAX8998_REG_LDO13),
 290         SAVE_ITEM(MAX8998_REG_LDO14),
 291         SAVE_ITEM(MAX8998_REG_LDO15),
 292         SAVE_ITEM(MAX8998_REG_LDO16),
 293         SAVE_ITEM(MAX8998_REG_LDO17),
 294         SAVE_ITEM(MAX8998_REG_BKCHR),
 295         SAVE_ITEM(MAX8998_REG_LBCNFG1),
 296         SAVE_ITEM(MAX8998_REG_LBCNFG2),
 297 };
 298 /* Save registers before hibernation */
 299 static int max8998_freeze(struct device *dev)
 300 {
 301         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
 302         int i;
 303
 304         for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
 305                 max8998_read_reg(i2c, max8998_dump[i].addr,
 306                                 &max8998_dump[i].val);
 307
 308         return 0;
 309 }
 310
 311 /* Restore registers after hibernation */
 312 static int max8998_restore(struct device *dev)
 313 {
 314         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
 315         int i;
 316
 317         for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
 318                 max8998_write_reg(i2c, max8998_dump[i].addr,
 319                                 max8998_dump[i].val);
 320
 321         return 0;
 322 }
 323
 324 static const struct dev_pm_ops max8998_pm = {
 325         .suspend = max8998_suspend,
 326         .resume = max8998_resume,
 327         .freeze = max8998_freeze,
 328         .restore = max8998_restore,
 329 };
 330
 331 static struct i2c_driver max8998_i2c_driver = {
 332         .driver = {
 333                    .name = "max8998",
 334                    .owner = THIS_MODULE,
 335                    .pm = &max8998_pm,
 336         },
 337         .probe = max8998_i2c_probe,
 338         .remove = max8998_i2c_remove,
 339         .id_table = max8998_i2c_id,
 340 };
 341
 342 static int __init max8998_i2c_init(void)
 343 {
 344         return i2c_add_driver(&max8998_i2c_driver);
 345 }
 346 /* init early so consumer devices can complete system boot */
 347 subsys_initcall(max8998_i2c_init);
 348
 349 static void __exit max8998_i2c_exit(void)
 350 {
 351         i2c_del_driver(&max8998_i2c_driver);
 352 }
 353 module_exit(max8998_i2c_exit);
 354
 355 MODULE_DESCRIPTION("MAXIM 8998 multi-function core driver");
 356 MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
 357 MODULE_LICENSE("GPL");