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@samsung.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.h> 28 #include <linux/of_irq.h> 29 #include <linux/interrupt.h> 30 #include <linux/pm_runtime.h> 31 #include <linux/init.h> 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 43 static const struct mfd_cell max8997_devs[] = { 44 { .name = "max8997-pmic", }, 45 { .name = "max8997-rtc", }, 46 { .name = "max8997-battery", }, 47 { .name = "max8997-haptic", }, 48 { .name = "max8997-muic", }, 49 { .name = "max8997-led", .id = 1 }, 50 { .name = "max8997-led", .id = 2 }, 51 }; 52 53 #ifdef CONFIG_OF 54 static const struct of_device_id max8997_pmic_dt_match[] = { 55 { .compatible = "maxim,max8997-pmic", .data = (void *)TYPE_MAX8997 }, 56 {}, 57 }; 58 #endif 59 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 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 167 static inline unsigned long max8997_i2c_get_driver_data(struct i2c_client *i2c, 168 const struct i2c_device_id *id) 169 { 170 if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) { 171 const struct of_device_id *match; 172 match = of_match_node(max8997_pmic_dt_match, i2c->dev.of_node); 173 return (unsigned long)match->data; 174 } 175 return id->driver_data; 176 } 177 178 static int max8997_i2c_probe(struct i2c_client *i2c, 179 const struct i2c_device_id *id) 180 { 181 struct max8997_dev *max8997; 182 struct max8997_platform_data *pdata = dev_get_platdata(&i2c->dev); 183 int ret = 0; 184 185 max8997 = devm_kzalloc(&i2c->dev, sizeof(struct max8997_dev), 186 GFP_KERNEL); 187 if (max8997 == NULL) 188 return -ENOMEM; 189 190 i2c_set_clientdata(i2c, max8997); 191 max8997->dev = &i2c->dev; 192 max8997->i2c = i2c; 193 max8997->type = max8997_i2c_get_driver_data(i2c, id); 194 max8997->irq = i2c->irq; 195 196 if (IS_ENABLED(CONFIG_OF) && max8997->dev->of_node) { 197 pdata = max8997_i2c_parse_dt_pdata(max8997->dev); 198 if (IS_ERR(pdata)) 199 return PTR_ERR(pdata); 200 } 201 202 if (!pdata) 203 return ret; 204 205 max8997->pdata = pdata; 206 max8997->ono = pdata->ono; 207 208 mutex_init(&max8997->iolock); 209 210 max8997->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC); 211 if (!max8997->rtc) { 212 dev_err(max8997->dev, "Failed to allocate I2C device for RTC\n"); 213 return -ENODEV; 214 } 215 i2c_set_clientdata(max8997->rtc, max8997); 216 217 max8997->haptic = i2c_new_dummy(i2c->adapter, I2C_ADDR_HAPTIC); 218 if (!max8997->haptic) { 219 dev_err(max8997->dev, "Failed to allocate I2C device for Haptic\n"); 220 ret = -ENODEV; 221 goto err_i2c_haptic; 222 } 223 i2c_set_clientdata(max8997->haptic, max8997); 224 225 max8997->muic = i2c_new_dummy(i2c->adapter, I2C_ADDR_MUIC); 226 if (!max8997->muic) { 227 dev_err(max8997->dev, "Failed to allocate I2C device for MUIC\n"); 228 ret = -ENODEV; 229 goto err_i2c_muic; 230 } 231 i2c_set_clientdata(max8997->muic, max8997); 232 233 pm_runtime_set_active(max8997->dev); 234 235 max8997_irq_init(max8997); 236 237 ret = mfd_add_devices(max8997->dev, -1, max8997_devs, 238 ARRAY_SIZE(max8997_devs), 239 NULL, 0, NULL); 240 if (ret < 0) { 241 dev_err(max8997->dev, "failed to add MFD devices %d\n", ret); 242 goto err_mfd; 243 } 244 245 /* 246 * TODO: enable others (flash, muic, rtc, battery, ...) and 247 * check the return value 248 */ 249 250 /* MAX8997 has a power button input. */ 251 device_init_wakeup(max8997->dev, pdata->wakeup); 252 253 return ret; 254 255 err_mfd: 256 mfd_remove_devices(max8997->dev); 257 i2c_unregister_device(max8997->muic); 258 err_i2c_muic: 259 i2c_unregister_device(max8997->haptic); 260 err_i2c_haptic: 261 i2c_unregister_device(max8997->rtc); 262 return ret; 263 } 264 265 static const struct i2c_device_id max8997_i2c_id[] = { 266 { "max8997", TYPE_MAX8997 }, 267 { "max8966", TYPE_MAX8966 }, 268 { } 269 }; 270 271 static u8 max8997_dumpaddr_pmic[] = { 272 MAX8997_REG_INT1MSK, 273 MAX8997_REG_INT2MSK, 274 MAX8997_REG_INT3MSK, 275 MAX8997_REG_INT4MSK, 276 MAX8997_REG_MAINCON1, 277 MAX8997_REG_MAINCON2, 278 MAX8997_REG_BUCKRAMP, 279 MAX8997_REG_BUCK1CTRL, 280 MAX8997_REG_BUCK1DVS1, 281 MAX8997_REG_BUCK1DVS2, 282 MAX8997_REG_BUCK1DVS3, 283 MAX8997_REG_BUCK1DVS4, 284 MAX8997_REG_BUCK1DVS5, 285 MAX8997_REG_BUCK1DVS6, 286 MAX8997_REG_BUCK1DVS7, 287 MAX8997_REG_BUCK1DVS8, 288 MAX8997_REG_BUCK2CTRL, 289 MAX8997_REG_BUCK2DVS1, 290 MAX8997_REG_BUCK2DVS2, 291 MAX8997_REG_BUCK2DVS3, 292 MAX8997_REG_BUCK2DVS4, 293 MAX8997_REG_BUCK2DVS5, 294 MAX8997_REG_BUCK2DVS6, 295 MAX8997_REG_BUCK2DVS7, 296 MAX8997_REG_BUCK2DVS8, 297 MAX8997_REG_BUCK3CTRL, 298 MAX8997_REG_BUCK3DVS, 299 MAX8997_REG_BUCK4CTRL, 300 MAX8997_REG_BUCK4DVS, 301 MAX8997_REG_BUCK5CTRL, 302 MAX8997_REG_BUCK5DVS1, 303 MAX8997_REG_BUCK5DVS2, 304 MAX8997_REG_BUCK5DVS3, 305 MAX8997_REG_BUCK5DVS4, 306 MAX8997_REG_BUCK5DVS5, 307 MAX8997_REG_BUCK5DVS6, 308 MAX8997_REG_BUCK5DVS7, 309 MAX8997_REG_BUCK5DVS8, 310 MAX8997_REG_BUCK6CTRL, 311 MAX8997_REG_BUCK6BPSKIPCTRL, 312 MAX8997_REG_BUCK7CTRL, 313 MAX8997_REG_BUCK7DVS, 314 MAX8997_REG_LDO1CTRL, 315 MAX8997_REG_LDO2CTRL, 316 MAX8997_REG_LDO3CTRL, 317 MAX8997_REG_LDO4CTRL, 318 MAX8997_REG_LDO5CTRL, 319 MAX8997_REG_LDO6CTRL, 320 MAX8997_REG_LDO7CTRL, 321 MAX8997_REG_LDO8CTRL, 322 MAX8997_REG_LDO9CTRL, 323 MAX8997_REG_LDO10CTRL, 324 MAX8997_REG_LDO11CTRL, 325 MAX8997_REG_LDO12CTRL, 326 MAX8997_REG_LDO13CTRL, 327 MAX8997_REG_LDO14CTRL, 328 MAX8997_REG_LDO15CTRL, 329 MAX8997_REG_LDO16CTRL, 330 MAX8997_REG_LDO17CTRL, 331 MAX8997_REG_LDO18CTRL, 332 MAX8997_REG_LDO21CTRL, 333 MAX8997_REG_MBCCTRL1, 334 MAX8997_REG_MBCCTRL2, 335 MAX8997_REG_MBCCTRL3, 336 MAX8997_REG_MBCCTRL4, 337 MAX8997_REG_MBCCTRL5, 338 MAX8997_REG_MBCCTRL6, 339 MAX8997_REG_OTPCGHCVS, 340 MAX8997_REG_SAFEOUTCTRL, 341 MAX8997_REG_LBCNFG1, 342 MAX8997_REG_LBCNFG2, 343 MAX8997_REG_BBCCTRL, 344 345 MAX8997_REG_FLASH1_CUR, 346 MAX8997_REG_FLASH2_CUR, 347 MAX8997_REG_MOVIE_CUR, 348 MAX8997_REG_GSMB_CUR, 349 MAX8997_REG_BOOST_CNTL, 350 MAX8997_REG_LEN_CNTL, 351 MAX8997_REG_FLASH_CNTL, 352 MAX8997_REG_WDT_CNTL, 353 MAX8997_REG_MAXFLASH1, 354 MAX8997_REG_MAXFLASH2, 355 MAX8997_REG_FLASHSTATUSMASK, 356 357 MAX8997_REG_GPIOCNTL1, 358 MAX8997_REG_GPIOCNTL2, 359 MAX8997_REG_GPIOCNTL3, 360 MAX8997_REG_GPIOCNTL4, 361 MAX8997_REG_GPIOCNTL5, 362 MAX8997_REG_GPIOCNTL6, 363 MAX8997_REG_GPIOCNTL7, 364 MAX8997_REG_GPIOCNTL8, 365 MAX8997_REG_GPIOCNTL9, 366 MAX8997_REG_GPIOCNTL10, 367 MAX8997_REG_GPIOCNTL11, 368 MAX8997_REG_GPIOCNTL12, 369 370 MAX8997_REG_LDO1CONFIG, 371 MAX8997_REG_LDO2CONFIG, 372 MAX8997_REG_LDO3CONFIG, 373 MAX8997_REG_LDO4CONFIG, 374 MAX8997_REG_LDO5CONFIG, 375 MAX8997_REG_LDO6CONFIG, 376 MAX8997_REG_LDO7CONFIG, 377 MAX8997_REG_LDO8CONFIG, 378 MAX8997_REG_LDO9CONFIG, 379 MAX8997_REG_LDO10CONFIG, 380 MAX8997_REG_LDO11CONFIG, 381 MAX8997_REG_LDO12CONFIG, 382 MAX8997_REG_LDO13CONFIG, 383 MAX8997_REG_LDO14CONFIG, 384 MAX8997_REG_LDO15CONFIG, 385 MAX8997_REG_LDO16CONFIG, 386 MAX8997_REG_LDO17CONFIG, 387 MAX8997_REG_LDO18CONFIG, 388 MAX8997_REG_LDO21CONFIG, 389 390 MAX8997_REG_DVSOKTIMER1, 391 MAX8997_REG_DVSOKTIMER2, 392 MAX8997_REG_DVSOKTIMER4, 393 MAX8997_REG_DVSOKTIMER5, 394 }; 395 396 static u8 max8997_dumpaddr_muic[] = { 397 MAX8997_MUIC_REG_INTMASK1, 398 MAX8997_MUIC_REG_INTMASK2, 399 MAX8997_MUIC_REG_INTMASK3, 400 MAX8997_MUIC_REG_CDETCTRL, 401 MAX8997_MUIC_REG_CONTROL1, 402 MAX8997_MUIC_REG_CONTROL2, 403 MAX8997_MUIC_REG_CONTROL3, 404 }; 405 406 static u8 max8997_dumpaddr_haptic[] = { 407 MAX8997_HAPTIC_REG_CONF1, 408 MAX8997_HAPTIC_REG_CONF2, 409 MAX8997_HAPTIC_REG_DRVCONF, 410 MAX8997_HAPTIC_REG_CYCLECONF1, 411 MAX8997_HAPTIC_REG_CYCLECONF2, 412 MAX8997_HAPTIC_REG_SIGCONF1, 413 MAX8997_HAPTIC_REG_SIGCONF2, 414 MAX8997_HAPTIC_REG_SIGCONF3, 415 MAX8997_HAPTIC_REG_SIGCONF4, 416 MAX8997_HAPTIC_REG_SIGDC1, 417 MAX8997_HAPTIC_REG_SIGDC2, 418 MAX8997_HAPTIC_REG_SIGPWMDC1, 419 MAX8997_HAPTIC_REG_SIGPWMDC2, 420 MAX8997_HAPTIC_REG_SIGPWMDC3, 421 MAX8997_HAPTIC_REG_SIGPWMDC4, 422 }; 423 424 static int max8997_freeze(struct device *dev) 425 { 426 struct i2c_client *i2c = to_i2c_client(dev); 427 struct max8997_dev *max8997 = i2c_get_clientdata(i2c); 428 int i; 429 430 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++) 431 max8997_read_reg(i2c, max8997_dumpaddr_pmic[i], 432 &max8997->reg_dump[i]); 433 434 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++) 435 max8997_read_reg(i2c, max8997_dumpaddr_muic[i], 436 &max8997->reg_dump[i + MAX8997_REG_PMIC_END]); 437 438 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++) 439 max8997_read_reg(i2c, max8997_dumpaddr_haptic[i], 440 &max8997->reg_dump[i + MAX8997_REG_PMIC_END + 441 MAX8997_MUIC_REG_END]); 442 443 return 0; 444 } 445 446 static int max8997_restore(struct device *dev) 447 { 448 struct i2c_client *i2c = to_i2c_client(dev); 449 struct max8997_dev *max8997 = i2c_get_clientdata(i2c); 450 int i; 451 452 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++) 453 max8997_write_reg(i2c, max8997_dumpaddr_pmic[i], 454 max8997->reg_dump[i]); 455 456 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++) 457 max8997_write_reg(i2c, max8997_dumpaddr_muic[i], 458 max8997->reg_dump[i + MAX8997_REG_PMIC_END]); 459 460 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++) 461 max8997_write_reg(i2c, max8997_dumpaddr_haptic[i], 462 max8997->reg_dump[i + MAX8997_REG_PMIC_END + 463 MAX8997_MUIC_REG_END]); 464 465 return 0; 466 } 467 468 static int max8997_suspend(struct device *dev) 469 { 470 struct i2c_client *i2c = to_i2c_client(dev); 471 struct max8997_dev *max8997 = i2c_get_clientdata(i2c); 472 473 if (device_may_wakeup(dev)) 474 irq_set_irq_wake(max8997->irq, 1); 475 return 0; 476 } 477 478 static int max8997_resume(struct device *dev) 479 { 480 struct i2c_client *i2c = to_i2c_client(dev); 481 struct max8997_dev *max8997 = i2c_get_clientdata(i2c); 482 483 if (device_may_wakeup(dev)) 484 irq_set_irq_wake(max8997->irq, 0); 485 return max8997_irq_resume(max8997); 486 } 487 488 static const struct dev_pm_ops max8997_pm = { 489 .suspend = max8997_suspend, 490 .resume = max8997_resume, 491 .freeze = max8997_freeze, 492 .restore = max8997_restore, 493 }; 494 495 static struct i2c_driver max8997_i2c_driver = { 496 .driver = { 497 .name = "max8997", 498 .pm = &max8997_pm, 499 .suppress_bind_attrs = true, 500 .of_match_table = of_match_ptr(max8997_pmic_dt_match), 501 }, 502 .probe = max8997_i2c_probe, 503 .id_table = max8997_i2c_id, 504 }; 505 506 static int __init max8997_i2c_init(void) 507 { 508 return i2c_add_driver(&max8997_i2c_driver); 509 } 510 /* init early so consumer devices can complete system boot */ 511 subsys_initcall(max8997_i2c_init); 512