drivers/mfd/max8997.c

   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
  24 #include <linux/slab.h>
  25 #include <linux/i2c.h>
  26 #include <linux/interrupt.h>
  27 #include <linux/pm_runtime.h>
  28 #include <linux/module.h>
  29 #include <linux/mutex.h>
  30 #include <linux/mfd/core.h>
  31 #include <linux/mfd/max8997.h>
  32 #include <linux/mfd/max8997-private.h>
  33
  34 #define I2C_ADDR_PMIC   (0xCC >> 1)
  35 #define I2C_ADDR_MUIC   (0x4A >> 1)
  36 #define I2C_ADDR_BATTERY        (0x6C >> 1)
  37 #define I2C_ADDR_RTC    (0x0C >> 1)
  38 #define I2C_ADDR_HAPTIC (0x90 >> 1)
  39
  40 static struct mfd_cell max8997_devs[] = {
  41         { .name = "max8997-pmic", },
  42         { .name = "max8997-rtc", },
  43         { .name = "max8997-battery", },
  44         { .name = "max8997-haptic", },
  45         { .name = "max8997-muic", },
  46         { .name = "max8997-flash", },
  47 };
  48
  49 int max8997_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
  50 {
  51         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  52         int ret;
  53
  54         mutex_lock(&max8997->iolock);
  55         ret = i2c_smbus_read_byte_data(i2c, reg);
  56         mutex_unlock(&max8997->iolock);
  57         if (ret < 0)
  58                 return ret;
  59
  60         ret &= 0xff;
  61         *dest = ret;
  62         return 0;
  63 }
  64 EXPORT_SYMBOL_GPL(max8997_read_reg);
  65
  66 int max8997_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
  67 {
  68         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  69         int ret;
  70
  71         mutex_lock(&max8997->iolock);
  72         ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
  73         mutex_unlock(&max8997->iolock);
  74         if (ret < 0)
  75                 return ret;
  76
  77         return 0;
  78 }
  79 EXPORT_SYMBOL_GPL(max8997_bulk_read);
  80
  81 int max8997_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
  82 {
  83         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  84         int ret;
  85
  86         mutex_lock(&max8997->iolock);
  87         ret = i2c_smbus_write_byte_data(i2c, reg, value);
  88         mutex_unlock(&max8997->iolock);
  89         return ret;
  90 }
  91 EXPORT_SYMBOL_GPL(max8997_write_reg);
  92
  93 int max8997_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
  94 {
  95         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  96         int ret;
  97
  98         mutex_lock(&max8997->iolock);
  99         ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
 100         mutex_unlock(&max8997->iolock);
 101         if (ret < 0)
 102                 return ret;
 103
 104         return 0;
 105 }
 106 EXPORT_SYMBOL_GPL(max8997_bulk_write);
 107
 108 int max8997_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
 109 {
 110         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
 111         int ret;
 112
 113         mutex_lock(&max8997->iolock);
 114         ret = i2c_smbus_read_byte_data(i2c, reg);
 115         if (ret >= 0) {
 116                 u8 old_val = ret & 0xff;
 117                 u8 new_val = (val & mask) | (old_val & (~mask));
 118                 ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
 119         }
 120         mutex_unlock(&max8997->iolock);
 121         return ret;
 122 }
 123 EXPORT_SYMBOL_GPL(max8997_update_reg);
 124
 125 static int max8997_i2c_probe(struct i2c_client *i2c,
 126                             const struct i2c_device_id *id)
 127 {
 128         struct max8997_dev *max8997;
 129         struct max8997_platform_data *pdata = i2c->dev.platform_data;
 130         int ret = 0;
 131
 132         max8997 = kzalloc(sizeof(struct max8997_dev), GFP_KERNEL);
 133         if (max8997 == NULL)
 134                 return -ENOMEM;
 135
 136         i2c_set_clientdata(i2c, max8997);
 137         max8997->dev = &i2c->dev;
 138         max8997->i2c = i2c;
 139         max8997->type = id->driver_data;
 140         max8997->irq = i2c->irq;
 141
 142         if (!pdata)
 143                 goto err;
 144
 145         max8997->irq_base = pdata->irq_base;
 146         max8997->ono = pdata->ono;
 147
 148         mutex_init(&max8997->iolock);
 149
 150         max8997->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
 151         i2c_set_clientdata(max8997->rtc, max8997);
 152         max8997->haptic = i2c_new_dummy(i2c->adapter, I2C_ADDR_HAPTIC);
 153         i2c_set_clientdata(max8997->haptic, max8997);
 154         max8997->muic = i2c_new_dummy(i2c->adapter, I2C_ADDR_MUIC);
 155         i2c_set_clientdata(max8997->muic, max8997);
 156
 157         pm_runtime_set_active(max8997->dev);
 158
 159         max8997_irq_init(max8997);
 160
 161         mfd_add_devices(max8997->dev, -1, max8997_devs,
 162                         ARRAY_SIZE(max8997_devs),
 163                         NULL, 0);
 164
 165         /*
 166          * TODO: enable others (flash, muic, rtc, battery, ...) and
 167          * check the return value
 168          */
 169
 170         if (ret < 0)
 171                 goto err_mfd;
 172
 173         /* MAX8997 has a power button input. */
 174         device_init_wakeup(max8997->dev, pdata->wakeup);
 175
 176         return ret;
 177
 178 err_mfd:
 179         mfd_remove_devices(max8997->dev);
 180         i2c_unregister_device(max8997->muic);
 181         i2c_unregister_device(max8997->haptic);
 182         i2c_unregister_device(max8997->rtc);
 183 err:
 184         kfree(max8997);
 185         return ret;
 186 }
 187
 188 static int max8997_i2c_remove(struct i2c_client *i2c)
 189 {
 190         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
 191
 192         mfd_remove_devices(max8997->dev);
 193         i2c_unregister_device(max8997->muic);
 194         i2c_unregister_device(max8997->haptic);
 195         i2c_unregister_device(max8997->rtc);
 196         kfree(max8997);
 197
 198         return 0;
 199 }
 200
 201 static const struct i2c_device_id max8997_i2c_id[] = {
 202         { "max8997", TYPE_MAX8997 },
 203         { "max8966", TYPE_MAX8966 },
 204         { }
 205 };
 206 MODULE_DEVICE_TABLE(i2c, max8998_i2c_id);
 207
 208 u8 max8997_dumpaddr_pmic[] = {
 209         MAX8997_REG_INT1MSK,
 210         MAX8997_REG_INT2MSK,
 211         MAX8997_REG_INT3MSK,
 212         MAX8997_REG_INT4MSK,
 213         MAX8997_REG_MAINCON1,
 214         MAX8997_REG_MAINCON2,
 215         MAX8997_REG_BUCKRAMP,
 216         MAX8997_REG_BUCK1CTRL,
 217         MAX8997_REG_BUCK1DVS1,
 218         MAX8997_REG_BUCK1DVS2,
 219         MAX8997_REG_BUCK1DVS3,
 220         MAX8997_REG_BUCK1DVS4,
 221         MAX8997_REG_BUCK1DVS5,
 222         MAX8997_REG_BUCK1DVS6,
 223         MAX8997_REG_BUCK1DVS7,
 224         MAX8997_REG_BUCK1DVS8,
 225         MAX8997_REG_BUCK2CTRL,
 226         MAX8997_REG_BUCK2DVS1,
 227         MAX8997_REG_BUCK2DVS2,
 228         MAX8997_REG_BUCK2DVS3,
 229         MAX8997_REG_BUCK2DVS4,
 230         MAX8997_REG_BUCK2DVS5,
 231         MAX8997_REG_BUCK2DVS6,
 232         MAX8997_REG_BUCK2DVS7,
 233         MAX8997_REG_BUCK2DVS8,
 234         MAX8997_REG_BUCK3CTRL,
 235         MAX8997_REG_BUCK3DVS,
 236         MAX8997_REG_BUCK4CTRL,
 237         MAX8997_REG_BUCK4DVS,
 238         MAX8997_REG_BUCK5CTRL,
 239         MAX8997_REG_BUCK5DVS1,
 240         MAX8997_REG_BUCK5DVS2,
 241         MAX8997_REG_BUCK5DVS3,
 242         MAX8997_REG_BUCK5DVS4,
 243         MAX8997_REG_BUCK5DVS5,
 244         MAX8997_REG_BUCK5DVS6,
 245         MAX8997_REG_BUCK5DVS7,
 246         MAX8997_REG_BUCK5DVS8,
 247         MAX8997_REG_BUCK6CTRL,
 248         MAX8997_REG_BUCK6BPSKIPCTRL,
 249         MAX8997_REG_BUCK7CTRL,
 250         MAX8997_REG_BUCK7DVS,
 251         MAX8997_REG_LDO1CTRL,
 252         MAX8997_REG_LDO2CTRL,
 253         MAX8997_REG_LDO3CTRL,
 254         MAX8997_REG_LDO4CTRL,
 255         MAX8997_REG_LDO5CTRL,
 256         MAX8997_REG_LDO6CTRL,
 257         MAX8997_REG_LDO7CTRL,
 258         MAX8997_REG_LDO8CTRL,
 259         MAX8997_REG_LDO9CTRL,
 260         MAX8997_REG_LDO10CTRL,
 261         MAX8997_REG_LDO11CTRL,
 262         MAX8997_REG_LDO12CTRL,
 263         MAX8997_REG_LDO13CTRL,
 264         MAX8997_REG_LDO14CTRL,
 265         MAX8997_REG_LDO15CTRL,
 266         MAX8997_REG_LDO16CTRL,
 267         MAX8997_REG_LDO17CTRL,
 268         MAX8997_REG_LDO18CTRL,
 269         MAX8997_REG_LDO21CTRL,
 270         MAX8997_REG_MBCCTRL1,
 271         MAX8997_REG_MBCCTRL2,
 272         MAX8997_REG_MBCCTRL3,
 273         MAX8997_REG_MBCCTRL4,
 274         MAX8997_REG_MBCCTRL5,
 275         MAX8997_REG_MBCCTRL6,
 276         MAX8997_REG_OTPCGHCVS,
 277         MAX8997_REG_SAFEOUTCTRL,
 278         MAX8997_REG_LBCNFG1,
 279         MAX8997_REG_LBCNFG2,
 280         MAX8997_REG_BBCCTRL,
 281
 282         MAX8997_REG_FLASH1_CUR,
 283         MAX8997_REG_FLASH2_CUR,
 284         MAX8997_REG_MOVIE_CUR,
 285         MAX8997_REG_GSMB_CUR,
 286         MAX8997_REG_BOOST_CNTL,
 287         MAX8997_REG_LEN_CNTL,
 288         MAX8997_REG_FLASH_CNTL,
 289         MAX8997_REG_WDT_CNTL,
 290         MAX8997_REG_MAXFLASH1,
 291         MAX8997_REG_MAXFLASH2,
 292         MAX8997_REG_FLASHSTATUSMASK,
 293
 294         MAX8997_REG_GPIOCNTL1,
 295         MAX8997_REG_GPIOCNTL2,
 296         MAX8997_REG_GPIOCNTL3,
 297         MAX8997_REG_GPIOCNTL4,
 298         MAX8997_REG_GPIOCNTL5,
 299         MAX8997_REG_GPIOCNTL6,
 300         MAX8997_REG_GPIOCNTL7,
 301         MAX8997_REG_GPIOCNTL8,
 302         MAX8997_REG_GPIOCNTL9,
 303         MAX8997_REG_GPIOCNTL10,
 304         MAX8997_REG_GPIOCNTL11,
 305         MAX8997_REG_GPIOCNTL12,
 306
 307         MAX8997_REG_LDO1CONFIG,
 308         MAX8997_REG_LDO2CONFIG,
 309         MAX8997_REG_LDO3CONFIG,
 310         MAX8997_REG_LDO4CONFIG,
 311         MAX8997_REG_LDO5CONFIG,
 312         MAX8997_REG_LDO6CONFIG,
 313         MAX8997_REG_LDO7CONFIG,
 314         MAX8997_REG_LDO8CONFIG,
 315         MAX8997_REG_LDO9CONFIG,
 316         MAX8997_REG_LDO10CONFIG,
 317         MAX8997_REG_LDO11CONFIG,
 318         MAX8997_REG_LDO12CONFIG,
 319         MAX8997_REG_LDO13CONFIG,
 320         MAX8997_REG_LDO14CONFIG,
 321         MAX8997_REG_LDO15CONFIG,
 322         MAX8997_REG_LDO16CONFIG,
 323         MAX8997_REG_LDO17CONFIG,
 324         MAX8997_REG_LDO18CONFIG,
 325         MAX8997_REG_LDO21CONFIG,
 326
 327         MAX8997_REG_DVSOKTIMER1,
 328         MAX8997_REG_DVSOKTIMER2,
 329         MAX8997_REG_DVSOKTIMER4,
 330         MAX8997_REG_DVSOKTIMER5,
 331 };
 332
 333 u8 max8997_dumpaddr_muic[] = {
 334         MAX8997_MUIC_REG_INTMASK1,
 335         MAX8997_MUIC_REG_INTMASK2,
 336         MAX8997_MUIC_REG_INTMASK3,
 337         MAX8997_MUIC_REG_CDETCTRL,
 338         MAX8997_MUIC_REG_CONTROL1,
 339         MAX8997_MUIC_REG_CONTROL2,
 340         MAX8997_MUIC_REG_CONTROL3,
 341 };
 342
 343 u8 max8997_dumpaddr_haptic[] = {
 344         MAX8997_HAPTIC_REG_CONF1,
 345         MAX8997_HAPTIC_REG_CONF2,
 346         MAX8997_HAPTIC_REG_DRVCONF,
 347         MAX8997_HAPTIC_REG_CYCLECONF1,
 348         MAX8997_HAPTIC_REG_CYCLECONF2,
 349         MAX8997_HAPTIC_REG_SIGCONF1,
 350         MAX8997_HAPTIC_REG_SIGCONF2,
 351         MAX8997_HAPTIC_REG_SIGCONF3,
 352         MAX8997_HAPTIC_REG_SIGCONF4,
 353         MAX8997_HAPTIC_REG_SIGDC1,
 354         MAX8997_HAPTIC_REG_SIGDC2,
 355         MAX8997_HAPTIC_REG_SIGPWMDC1,
 356         MAX8997_HAPTIC_REG_SIGPWMDC2,
 357         MAX8997_HAPTIC_REG_SIGPWMDC3,
 358         MAX8997_HAPTIC_REG_SIGPWMDC4,
 359 };
 360
 361 static int max8997_freeze(struct device *dev)
 362 {
 363         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
 364         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
 365         int i;
 366
 367         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
 368                 max8997_read_reg(i2c, max8997_dumpaddr_pmic[i],
 369                                 &max8997->reg_dump[i]);
 370
 371         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
 372                 max8997_read_reg(i2c, max8997_dumpaddr_muic[i],
 373                                 &max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
 374
 375         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
 376                 max8997_read_reg(i2c, max8997_dumpaddr_haptic[i],
 377                                 &max8997->reg_dump[i + MAX8997_REG_PMIC_END +
 378                                 MAX8997_MUIC_REG_END]);
 379
 380         return 0;
 381 }
 382
 383 static int max8997_restore(struct device *dev)
 384 {
 385         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
 386         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
 387         int i;
 388
 389         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
 390                 max8997_write_reg(i2c, max8997_dumpaddr_pmic[i],
 391                                 max8997->reg_dump[i]);
 392
 393         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
 394                 max8997_write_reg(i2c, max8997_dumpaddr_muic[i],
 395                                 max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
 396
 397         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
 398                 max8997_write_reg(i2c, max8997_dumpaddr_haptic[i],
 399                                 max8997->reg_dump[i + MAX8997_REG_PMIC_END +
 400                                 MAX8997_MUIC_REG_END]);
 401
 402         return 0;
 403 }
 404
 405 static int max8997_suspend(struct device *dev)
 406 {
 407         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
 408         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
 409
 410         if (device_may_wakeup(dev))
 411                 irq_set_irq_wake(max8997->irq, 1);
 412         return 0;
 413 }
 414
 415 static int max8997_resume(struct device *dev)
 416 {
 417         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
 418         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
 419
 420         if (device_may_wakeup(dev))
 421                 irq_set_irq_wake(max8997->irq, 0);
 422         return max8997_irq_resume(max8997);
 423 }
 424
 425 const struct dev_pm_ops max8997_pm = {
 426         .suspend = max8997_suspend,
 427         .resume = max8997_resume,
 428         .freeze = max8997_freeze,
 429         .restore = max8997_restore,
 430 };
 431
 432 static struct i2c_driver max8997_i2c_driver = {
 433         .driver = {
 434                    .name = "max8997",
 435                    .owner = THIS_MODULE,
 436                    .pm = &max8997_pm,
 437         },
 438         .probe = max8997_i2c_probe,
 439         .remove = max8997_i2c_remove,
 440         .id_table = max8997_i2c_id,
 441 };
 442
 443 static int __init max8997_i2c_init(void)
 444 {
 445         return i2c_add_driver(&max8997_i2c_driver);
 446 }
 447 /* init early so consumer devices can complete system boot */
 448 subsys_initcall(max8997_i2c_init);
 449
 450 static void __exit max8997_i2c_exit(void)
 451 {
 452         i2c_del_driver(&max8997_i2c_driver);
 453 }
 454 module_exit(max8997_i2c_exit);
 455
 456 MODULE_DESCRIPTION("MAXIM 8997 multi-function core driver");
 457 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
 458 MODULE_LICENSE("GPL");