2 * max8997.c - mfd core driver for the Maxim 8966 and 8997
4 * Copyright (C) 2011 Samsung Electronics
5 * MyungJoo Ham <myungjoo.ham@smasung.com>
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.
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.
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
21 * This driver is based on max8998.c
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>
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)
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 },
53 static struct of_device_id max8997_pmic_dt_match[] = {
54 { .compatible = "maxim,max8997-pmic", .data = TYPE_MAX8997 },
59 int max8997_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
61 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
64 mutex_lock(&max8997->iolock);
65 ret = i2c_smbus_read_byte_data(i2c, reg);
66 mutex_unlock(&max8997->iolock);
74 EXPORT_SYMBOL_GPL(max8997_read_reg);
76 int max8997_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
78 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
81 mutex_lock(&max8997->iolock);
82 ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
83 mutex_unlock(&max8997->iolock);
89 EXPORT_SYMBOL_GPL(max8997_bulk_read);
91 int max8997_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
93 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
96 mutex_lock(&max8997->iolock);
97 ret = i2c_smbus_write_byte_data(i2c, reg, value);
98 mutex_unlock(&max8997->iolock);
101 EXPORT_SYMBOL_GPL(max8997_write_reg);
103 int max8997_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
105 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
108 mutex_lock(&max8997->iolock);
109 ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
110 mutex_unlock(&max8997->iolock);
116 EXPORT_SYMBOL_GPL(max8997_bulk_write);
118 int max8997_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
120 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
123 mutex_lock(&max8997->iolock);
124 ret = i2c_smbus_read_byte_data(i2c, reg);
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);
130 mutex_unlock(&max8997->iolock);
133 EXPORT_SYMBOL_GPL(max8997_update_reg);
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.
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
145 static struct max8997_platform_data *max8997_i2c_parse_dt_pdata(
148 struct max8997_platform_data *pd;
150 pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
152 dev_err(dev, "could not allocate memory for pdata\n");
153 return ERR_PTR(-ENOMEM);
156 pd->ono = irq_of_parse_and_map(dev->of_node, 1);
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
167 static struct max8997_platform_data *max8997_i2c_parse_dt_pdata(
174 static inline int max8997_i2c_get_driver_data(struct i2c_client *i2c,
175 const struct i2c_device_id *id)
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;
184 return (int)id->driver_data;
187 static int max8997_i2c_probe(struct i2c_client *i2c,
188 const struct i2c_device_id *id)
190 struct max8997_dev *max8997;
191 struct max8997_platform_data *pdata = i2c->dev.platform_data;
194 max8997 = kzalloc(sizeof(struct max8997_dev), GFP_KERNEL);
198 i2c_set_clientdata(i2c, max8997);
199 max8997->dev = &i2c->dev;
201 max8997->type = max8997_i2c_get_driver_data(i2c, id);
202 max8997->irq = i2c->irq;
204 if (max8997->dev->of_node) {
205 pdata = max8997_i2c_parse_dt_pdata(max8997->dev);
207 ret = PTR_ERR(pdata);
215 max8997->pdata = pdata;
216 max8997->ono = pdata->ono;
218 mutex_init(&max8997->iolock);
220 max8997->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
222 dev_err(max8997->dev, "Failed to allocate I2C device for RTC\n");
225 i2c_set_clientdata(max8997->rtc, max8997);
227 max8997->haptic = i2c_new_dummy(i2c->adapter, I2C_ADDR_HAPTIC);
228 if (!max8997->haptic) {
229 dev_err(max8997->dev, "Failed to allocate I2C device for Haptic\n");
233 i2c_set_clientdata(max8997->haptic, max8997);
235 max8997->muic = i2c_new_dummy(i2c->adapter, I2C_ADDR_MUIC);
236 if (!max8997->muic) {
237 dev_err(max8997->dev, "Failed to allocate I2C device for MUIC\n");
241 i2c_set_clientdata(max8997->muic, max8997);
243 pm_runtime_set_active(max8997->dev);
245 max8997_irq_init(max8997);
247 mfd_add_devices(max8997->dev, -1, max8997_devs,
248 ARRAY_SIZE(max8997_devs),
252 * TODO: enable others (flash, muic, rtc, battery, ...) and
253 * check the return value
259 /* MAX8997 has a power button input. */
260 device_init_wakeup(max8997->dev, pdata->wakeup);
265 mfd_remove_devices(max8997->dev);
266 i2c_unregister_device(max8997->muic);
268 i2c_unregister_device(max8997->haptic);
270 i2c_unregister_device(max8997->rtc);
276 static int max8997_i2c_remove(struct i2c_client *i2c)
278 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
280 mfd_remove_devices(max8997->dev);
281 i2c_unregister_device(max8997->muic);
282 i2c_unregister_device(max8997->haptic);
283 i2c_unregister_device(max8997->rtc);
289 static const struct i2c_device_id max8997_i2c_id[] = {
290 { "max8997", TYPE_MAX8997 },
291 { "max8966", TYPE_MAX8966 },
294 MODULE_DEVICE_TABLE(i2c, max8998_i2c_id);
296 static u8 max8997_dumpaddr_pmic[] = {
301 MAX8997_REG_MAINCON1,
302 MAX8997_REG_MAINCON2,
303 MAX8997_REG_BUCKRAMP,
304 MAX8997_REG_BUCK1CTRL,
305 MAX8997_REG_BUCK1DVS1,
306 MAX8997_REG_BUCK1DVS2,
307 MAX8997_REG_BUCK1DVS3,
308 MAX8997_REG_BUCK1DVS4,
309 MAX8997_REG_BUCK1DVS5,
310 MAX8997_REG_BUCK1DVS6,
311 MAX8997_REG_BUCK1DVS7,
312 MAX8997_REG_BUCK1DVS8,
313 MAX8997_REG_BUCK2CTRL,
314 MAX8997_REG_BUCK2DVS1,
315 MAX8997_REG_BUCK2DVS2,
316 MAX8997_REG_BUCK2DVS3,
317 MAX8997_REG_BUCK2DVS4,
318 MAX8997_REG_BUCK2DVS5,
319 MAX8997_REG_BUCK2DVS6,
320 MAX8997_REG_BUCK2DVS7,
321 MAX8997_REG_BUCK2DVS8,
322 MAX8997_REG_BUCK3CTRL,
323 MAX8997_REG_BUCK3DVS,
324 MAX8997_REG_BUCK4CTRL,
325 MAX8997_REG_BUCK4DVS,
326 MAX8997_REG_BUCK5CTRL,
327 MAX8997_REG_BUCK5DVS1,
328 MAX8997_REG_BUCK5DVS2,
329 MAX8997_REG_BUCK5DVS3,
330 MAX8997_REG_BUCK5DVS4,
331 MAX8997_REG_BUCK5DVS5,
332 MAX8997_REG_BUCK5DVS6,
333 MAX8997_REG_BUCK5DVS7,
334 MAX8997_REG_BUCK5DVS8,
335 MAX8997_REG_BUCK6CTRL,
336 MAX8997_REG_BUCK6BPSKIPCTRL,
337 MAX8997_REG_BUCK7CTRL,
338 MAX8997_REG_BUCK7DVS,
339 MAX8997_REG_LDO1CTRL,
340 MAX8997_REG_LDO2CTRL,
341 MAX8997_REG_LDO3CTRL,
342 MAX8997_REG_LDO4CTRL,
343 MAX8997_REG_LDO5CTRL,
344 MAX8997_REG_LDO6CTRL,
345 MAX8997_REG_LDO7CTRL,
346 MAX8997_REG_LDO8CTRL,
347 MAX8997_REG_LDO9CTRL,
348 MAX8997_REG_LDO10CTRL,
349 MAX8997_REG_LDO11CTRL,
350 MAX8997_REG_LDO12CTRL,
351 MAX8997_REG_LDO13CTRL,
352 MAX8997_REG_LDO14CTRL,
353 MAX8997_REG_LDO15CTRL,
354 MAX8997_REG_LDO16CTRL,
355 MAX8997_REG_LDO17CTRL,
356 MAX8997_REG_LDO18CTRL,
357 MAX8997_REG_LDO21CTRL,
358 MAX8997_REG_MBCCTRL1,
359 MAX8997_REG_MBCCTRL2,
360 MAX8997_REG_MBCCTRL3,
361 MAX8997_REG_MBCCTRL4,
362 MAX8997_REG_MBCCTRL5,
363 MAX8997_REG_MBCCTRL6,
364 MAX8997_REG_OTPCGHCVS,
365 MAX8997_REG_SAFEOUTCTRL,
370 MAX8997_REG_FLASH1_CUR,
371 MAX8997_REG_FLASH2_CUR,
372 MAX8997_REG_MOVIE_CUR,
373 MAX8997_REG_GSMB_CUR,
374 MAX8997_REG_BOOST_CNTL,
375 MAX8997_REG_LEN_CNTL,
376 MAX8997_REG_FLASH_CNTL,
377 MAX8997_REG_WDT_CNTL,
378 MAX8997_REG_MAXFLASH1,
379 MAX8997_REG_MAXFLASH2,
380 MAX8997_REG_FLASHSTATUSMASK,
382 MAX8997_REG_GPIOCNTL1,
383 MAX8997_REG_GPIOCNTL2,
384 MAX8997_REG_GPIOCNTL3,
385 MAX8997_REG_GPIOCNTL4,
386 MAX8997_REG_GPIOCNTL5,
387 MAX8997_REG_GPIOCNTL6,
388 MAX8997_REG_GPIOCNTL7,
389 MAX8997_REG_GPIOCNTL8,
390 MAX8997_REG_GPIOCNTL9,
391 MAX8997_REG_GPIOCNTL10,
392 MAX8997_REG_GPIOCNTL11,
393 MAX8997_REG_GPIOCNTL12,
395 MAX8997_REG_LDO1CONFIG,
396 MAX8997_REG_LDO2CONFIG,
397 MAX8997_REG_LDO3CONFIG,
398 MAX8997_REG_LDO4CONFIG,
399 MAX8997_REG_LDO5CONFIG,
400 MAX8997_REG_LDO6CONFIG,
401 MAX8997_REG_LDO7CONFIG,
402 MAX8997_REG_LDO8CONFIG,
403 MAX8997_REG_LDO9CONFIG,
404 MAX8997_REG_LDO10CONFIG,
405 MAX8997_REG_LDO11CONFIG,
406 MAX8997_REG_LDO12CONFIG,
407 MAX8997_REG_LDO13CONFIG,
408 MAX8997_REG_LDO14CONFIG,
409 MAX8997_REG_LDO15CONFIG,
410 MAX8997_REG_LDO16CONFIG,
411 MAX8997_REG_LDO17CONFIG,
412 MAX8997_REG_LDO18CONFIG,
413 MAX8997_REG_LDO21CONFIG,
415 MAX8997_REG_DVSOKTIMER1,
416 MAX8997_REG_DVSOKTIMER2,
417 MAX8997_REG_DVSOKTIMER4,
418 MAX8997_REG_DVSOKTIMER5,
421 static u8 max8997_dumpaddr_muic[] = {
422 MAX8997_MUIC_REG_INTMASK1,
423 MAX8997_MUIC_REG_INTMASK2,
424 MAX8997_MUIC_REG_INTMASK3,
425 MAX8997_MUIC_REG_CDETCTRL,
426 MAX8997_MUIC_REG_CONTROL1,
427 MAX8997_MUIC_REG_CONTROL2,
428 MAX8997_MUIC_REG_CONTROL3,
431 static u8 max8997_dumpaddr_haptic[] = {
432 MAX8997_HAPTIC_REG_CONF1,
433 MAX8997_HAPTIC_REG_CONF2,
434 MAX8997_HAPTIC_REG_DRVCONF,
435 MAX8997_HAPTIC_REG_CYCLECONF1,
436 MAX8997_HAPTIC_REG_CYCLECONF2,
437 MAX8997_HAPTIC_REG_SIGCONF1,
438 MAX8997_HAPTIC_REG_SIGCONF2,
439 MAX8997_HAPTIC_REG_SIGCONF3,
440 MAX8997_HAPTIC_REG_SIGCONF4,
441 MAX8997_HAPTIC_REG_SIGDC1,
442 MAX8997_HAPTIC_REG_SIGDC2,
443 MAX8997_HAPTIC_REG_SIGPWMDC1,
444 MAX8997_HAPTIC_REG_SIGPWMDC2,
445 MAX8997_HAPTIC_REG_SIGPWMDC3,
446 MAX8997_HAPTIC_REG_SIGPWMDC4,
449 static int max8997_freeze(struct device *dev)
451 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
452 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
455 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
456 max8997_read_reg(i2c, max8997_dumpaddr_pmic[i],
457 &max8997->reg_dump[i]);
459 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
460 max8997_read_reg(i2c, max8997_dumpaddr_muic[i],
461 &max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
463 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
464 max8997_read_reg(i2c, max8997_dumpaddr_haptic[i],
465 &max8997->reg_dump[i + MAX8997_REG_PMIC_END +
466 MAX8997_MUIC_REG_END]);
471 static int max8997_restore(struct device *dev)
473 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
474 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
477 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
478 max8997_write_reg(i2c, max8997_dumpaddr_pmic[i],
479 max8997->reg_dump[i]);
481 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
482 max8997_write_reg(i2c, max8997_dumpaddr_muic[i],
483 max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
485 for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
486 max8997_write_reg(i2c, max8997_dumpaddr_haptic[i],
487 max8997->reg_dump[i + MAX8997_REG_PMIC_END +
488 MAX8997_MUIC_REG_END]);
493 static int max8997_suspend(struct device *dev)
495 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
496 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
498 if (device_may_wakeup(dev))
499 irq_set_irq_wake(max8997->irq, 1);
503 static int max8997_resume(struct device *dev)
505 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
506 struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
508 if (device_may_wakeup(dev))
509 irq_set_irq_wake(max8997->irq, 0);
510 return max8997_irq_resume(max8997);
513 static const struct dev_pm_ops max8997_pm = {
514 .suspend = max8997_suspend,
515 .resume = max8997_resume,
516 .freeze = max8997_freeze,
517 .restore = max8997_restore,
520 static struct i2c_driver max8997_i2c_driver = {
523 .owner = THIS_MODULE,
525 .of_match_table = of_match_ptr(max8997_pmic_dt_match),
527 .probe = max8997_i2c_probe,
528 .remove = max8997_i2c_remove,
529 .id_table = max8997_i2c_id,
532 static int __init max8997_i2c_init(void)
534 return i2c_add_driver(&max8997_i2c_driver);
536 /* init early so consumer devices can complete system boot */
537 subsys_initcall(max8997_i2c_init);
539 static void __exit max8997_i2c_exit(void)
541 i2c_del_driver(&max8997_i2c_driver);
543 module_exit(max8997_i2c_exit);
545 MODULE_DESCRIPTION("MAXIM 8997 multi-function core driver");
546 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
547 MODULE_LICENSE("GPL");