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