1 // SPDX-License-Identifier: GPL-2.0+
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd
4 // http://www.samsung.com
6 #include <linux/module.h>
7 #include <linux/moduleparam.h>
8 #include <linux/init.h>
10 #include <linux/slab.h>
11 #include <linux/i2c.h>
13 #include <linux/of_irq.h>
14 #include <linux/interrupt.h>
15 #include <linux/pm_runtime.h>
16 #include <linux/mutex.h>
17 #include <linux/mfd/core.h>
18 #include <linux/mfd/samsung/core.h>
19 #include <linux/mfd/samsung/irq.h>
20 #include <linux/mfd/samsung/s2mpa01.h>
21 #include <linux/mfd/samsung/s2mps11.h>
22 #include <linux/mfd/samsung/s2mps13.h>
23 #include <linux/mfd/samsung/s2mps14.h>
24 #include <linux/mfd/samsung/s2mps15.h>
25 #include <linux/mfd/samsung/s2mpu02.h>
26 #include <linux/mfd/samsung/s5m8763.h>
27 #include <linux/mfd/samsung/s5m8767.h>
28 #include <linux/regmap.h>
30 static const struct mfd_cell s5m8751_devs[] = {
32 .name = "s5m8751-pmic",
34 .name = "s5m-charger",
36 .name = "s5m8751-codec",
40 static const struct mfd_cell s5m8763_devs[] = {
42 .name = "s5m8763-pmic",
46 .name = "s5m-charger",
50 static const struct mfd_cell s5m8767_devs[] = {
52 .name = "s5m8767-pmic",
56 .name = "s5m8767-clk",
57 .of_compatible = "samsung,s5m8767-clk",
61 static const struct mfd_cell s2mps11_devs[] = {
63 .name = "s2mps11-regulator",
65 .name = "s2mps14-rtc",
67 .name = "s2mps11-clk",
68 .of_compatible = "samsung,s2mps11-clk",
72 static const struct mfd_cell s2mps13_devs[] = {
73 { .name = "s2mps13-regulator", },
74 { .name = "s2mps13-rtc", },
76 .name = "s2mps13-clk",
77 .of_compatible = "samsung,s2mps13-clk",
81 static const struct mfd_cell s2mps14_devs[] = {
83 .name = "s2mps14-regulator",
85 .name = "s2mps14-rtc",
87 .name = "s2mps14-clk",
88 .of_compatible = "samsung,s2mps14-clk",
92 static const struct mfd_cell s2mps15_devs[] = {
94 .name = "s2mps15-regulator",
96 .name = "s2mps15-rtc",
98 .name = "s2mps13-clk",
99 .of_compatible = "samsung,s2mps13-clk",
103 static const struct mfd_cell s2mpa01_devs[] = {
105 .name = "s2mpa01-pmic",
109 static const struct mfd_cell s2mpu02_devs[] = {
111 .name = "s2mpu02-regulator",
116 static const struct of_device_id sec_dt_match[] = {
118 .compatible = "samsung,s5m8767-pmic",
119 .data = (void *)S5M8767X,
121 .compatible = "samsung,s2mps11-pmic",
122 .data = (void *)S2MPS11X,
124 .compatible = "samsung,s2mps13-pmic",
125 .data = (void *)S2MPS13X,
127 .compatible = "samsung,s2mps14-pmic",
128 .data = (void *)S2MPS14X,
130 .compatible = "samsung,s2mps15-pmic",
131 .data = (void *)S2MPS15X,
133 .compatible = "samsung,s2mpa01-pmic",
134 .data = (void *)S2MPA01,
136 .compatible = "samsung,s2mpu02-pmic",
137 .data = (void *)S2MPU02,
142 MODULE_DEVICE_TABLE(of, sec_dt_match);
145 static bool s2mpa01_volatile(struct device *dev, unsigned int reg)
148 case S2MPA01_REG_INT1M:
149 case S2MPA01_REG_INT2M:
150 case S2MPA01_REG_INT3M:
157 static bool s2mps11_volatile(struct device *dev, unsigned int reg)
160 case S2MPS11_REG_INT1M:
161 case S2MPS11_REG_INT2M:
162 case S2MPS11_REG_INT3M:
169 static bool s2mpu02_volatile(struct device *dev, unsigned int reg)
172 case S2MPU02_REG_INT1M:
173 case S2MPU02_REG_INT2M:
174 case S2MPU02_REG_INT3M:
181 static bool s5m8763_volatile(struct device *dev, unsigned int reg)
184 case S5M8763_REG_IRQM1:
185 case S5M8763_REG_IRQM2:
186 case S5M8763_REG_IRQM3:
187 case S5M8763_REG_IRQM4:
194 static const struct regmap_config sec_regmap_config = {
199 static const struct regmap_config s2mpa01_regmap_config = {
203 .max_register = S2MPA01_REG_LDO_OVCB4,
204 .volatile_reg = s2mpa01_volatile,
205 .cache_type = REGCACHE_FLAT,
208 static const struct regmap_config s2mps11_regmap_config = {
212 .max_register = S2MPS11_REG_L38CTRL,
213 .volatile_reg = s2mps11_volatile,
214 .cache_type = REGCACHE_FLAT,
217 static const struct regmap_config s2mps13_regmap_config = {
221 .max_register = S2MPS13_REG_LDODSCH5,
222 .volatile_reg = s2mps11_volatile,
223 .cache_type = REGCACHE_FLAT,
226 static const struct regmap_config s2mps14_regmap_config = {
230 .max_register = S2MPS14_REG_LDODSCH3,
231 .volatile_reg = s2mps11_volatile,
232 .cache_type = REGCACHE_FLAT,
235 static const struct regmap_config s2mps15_regmap_config = {
239 .max_register = S2MPS15_REG_LDODSCH4,
240 .volatile_reg = s2mps11_volatile,
241 .cache_type = REGCACHE_FLAT,
244 static const struct regmap_config s2mpu02_regmap_config = {
248 .max_register = S2MPU02_REG_DVSDATA,
249 .volatile_reg = s2mpu02_volatile,
250 .cache_type = REGCACHE_FLAT,
253 static const struct regmap_config s5m8763_regmap_config = {
257 .max_register = S5M8763_REG_LBCNFG2,
258 .volatile_reg = s5m8763_volatile,
259 .cache_type = REGCACHE_FLAT,
262 static const struct regmap_config s5m8767_regmap_config = {
266 .max_register = S5M8767_REG_LDO28CTRL,
267 .volatile_reg = s2mps11_volatile,
268 .cache_type = REGCACHE_FLAT,
271 static void sec_pmic_dump_rev(struct sec_pmic_dev *sec_pmic)
275 /* For each device type, the REG_ID is always the first register */
276 if (!regmap_read(sec_pmic->regmap_pmic, S2MPS11_REG_ID, &val))
277 dev_dbg(sec_pmic->dev, "Revision: 0x%x\n", val);
280 static void sec_pmic_configure(struct sec_pmic_dev *sec_pmic)
284 if (sec_pmic->device_type != S2MPS13X)
287 if (sec_pmic->pdata->disable_wrstbi) {
289 * If WRSTBI pin is pulled down this feature must be disabled
290 * because each Suspend to RAM will trigger buck voltage reset
293 err = regmap_update_bits(sec_pmic->regmap_pmic,
295 S2MPS13_REG_WRSTBI_MASK, 0x0);
297 dev_warn(sec_pmic->dev,
298 "Cannot initialize WRSTBI config: %d\n",
305 * Only the common platform data elements for s5m8767 are parsed here from the
306 * device tree. Other sub-modules of s5m8767 such as pmic, rtc , charger and
307 * others have to parse their own platform data elements from device tree.
309 * The s5m8767 platform data structure is instantiated here and the drivers for
310 * the sub-modules need not instantiate another instance while parsing their
313 static struct sec_platform_data *
314 sec_pmic_i2c_parse_dt_pdata(struct device *dev)
316 struct sec_platform_data *pd;
318 pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
320 return ERR_PTR(-ENOMEM);
323 * ToDo: the 'wakeup' member in the platform data is more of a linux
324 * specfic information. Hence, there is no binding for that yet and
328 pd->manual_poweroff = of_property_read_bool(dev->of_node,
329 "samsung,s2mps11-acokb-ground");
330 pd->disable_wrstbi = of_property_read_bool(dev->of_node,
331 "samsung,s2mps11-wrstbi-ground");
335 static struct sec_platform_data *
336 sec_pmic_i2c_parse_dt_pdata(struct device *dev)
342 static inline unsigned long sec_i2c_get_driver_data(struct i2c_client *i2c,
343 const struct i2c_device_id *id)
346 if (i2c->dev.of_node) {
347 const struct of_device_id *match;
349 match = of_match_node(sec_dt_match, i2c->dev.of_node);
350 return (unsigned long)match->data;
353 return id->driver_data;
356 static int sec_pmic_probe(struct i2c_client *i2c,
357 const struct i2c_device_id *id)
359 struct sec_platform_data *pdata = dev_get_platdata(&i2c->dev);
360 const struct regmap_config *regmap;
361 const struct mfd_cell *sec_devs;
362 struct sec_pmic_dev *sec_pmic;
363 unsigned long device_type;
364 int ret, num_sec_devs;
366 sec_pmic = devm_kzalloc(&i2c->dev, sizeof(struct sec_pmic_dev),
368 if (sec_pmic == NULL)
371 i2c_set_clientdata(i2c, sec_pmic);
372 sec_pmic->dev = &i2c->dev;
374 sec_pmic->irq = i2c->irq;
375 device_type = sec_i2c_get_driver_data(i2c, id);
377 if (sec_pmic->dev->of_node) {
378 pdata = sec_pmic_i2c_parse_dt_pdata(sec_pmic->dev);
380 ret = PTR_ERR(pdata);
383 pdata->device_type = device_type;
386 sec_pmic->device_type = pdata->device_type;
387 sec_pmic->irq_base = pdata->irq_base;
388 sec_pmic->wakeup = pdata->wakeup;
389 sec_pmic->pdata = pdata;
392 switch (sec_pmic->device_type) {
394 regmap = &s2mpa01_regmap_config;
397 regmap = &s2mps11_regmap_config;
400 regmap = &s2mps13_regmap_config;
403 regmap = &s2mps14_regmap_config;
406 regmap = &s2mps15_regmap_config;
409 regmap = &s5m8763_regmap_config;
412 regmap = &s5m8767_regmap_config;
415 regmap = &s2mpu02_regmap_config;
418 regmap = &sec_regmap_config;
422 sec_pmic->regmap_pmic = devm_regmap_init_i2c(i2c, regmap);
423 if (IS_ERR(sec_pmic->regmap_pmic)) {
424 ret = PTR_ERR(sec_pmic->regmap_pmic);
425 dev_err(&i2c->dev, "Failed to allocate register map: %d\n",
430 if (pdata && pdata->cfg_pmic_irq)
431 pdata->cfg_pmic_irq();
433 sec_irq_init(sec_pmic);
435 pm_runtime_set_active(sec_pmic->dev);
437 switch (sec_pmic->device_type) {
439 sec_devs = s5m8751_devs;
440 num_sec_devs = ARRAY_SIZE(s5m8751_devs);
443 sec_devs = s5m8763_devs;
444 num_sec_devs = ARRAY_SIZE(s5m8763_devs);
447 sec_devs = s5m8767_devs;
448 num_sec_devs = ARRAY_SIZE(s5m8767_devs);
451 sec_devs = s2mpa01_devs;
452 num_sec_devs = ARRAY_SIZE(s2mpa01_devs);
455 sec_devs = s2mps11_devs;
456 num_sec_devs = ARRAY_SIZE(s2mps11_devs);
459 sec_devs = s2mps13_devs;
460 num_sec_devs = ARRAY_SIZE(s2mps13_devs);
463 sec_devs = s2mps14_devs;
464 num_sec_devs = ARRAY_SIZE(s2mps14_devs);
467 sec_devs = s2mps15_devs;
468 num_sec_devs = ARRAY_SIZE(s2mps15_devs);
471 sec_devs = s2mpu02_devs;
472 num_sec_devs = ARRAY_SIZE(s2mpu02_devs);
475 dev_err(&i2c->dev, "Unsupported device type (%lu)\n",
476 sec_pmic->device_type);
479 ret = devm_mfd_add_devices(sec_pmic->dev, -1, sec_devs, num_sec_devs,
484 device_init_wakeup(sec_pmic->dev, sec_pmic->wakeup);
485 sec_pmic_configure(sec_pmic);
486 sec_pmic_dump_rev(sec_pmic);
491 static void sec_pmic_shutdown(struct i2c_client *i2c)
493 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
494 unsigned int reg, mask;
496 if (!sec_pmic->pdata->manual_poweroff)
499 switch (sec_pmic->device_type) {
501 reg = S2MPS11_REG_CTRL1;
502 mask = S2MPS11_CTRL1_PWRHOLD_MASK;
506 * Currently only one board with S2MPS11 needs this, so just
509 dev_warn(sec_pmic->dev,
510 "Unsupported device %lu for manual power off\n",
511 sec_pmic->device_type);
515 regmap_update_bits(sec_pmic->regmap_pmic, reg, mask, 0);
518 #ifdef CONFIG_PM_SLEEP
519 static int sec_pmic_suspend(struct device *dev)
521 struct i2c_client *i2c = to_i2c_client(dev);
522 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
524 if (device_may_wakeup(dev))
525 enable_irq_wake(sec_pmic->irq);
527 * PMIC IRQ must be disabled during suspend for RTC alarm
529 * When device is woken up from suspend, an
530 * interrupt occurs before resuming I2C bus controller.
531 * The interrupt is handled by regmap_irq_thread which tries
532 * to read RTC registers. This read fails (I2C is still
533 * suspended) and RTC Alarm interrupt is disabled.
535 disable_irq(sec_pmic->irq);
540 static int sec_pmic_resume(struct device *dev)
542 struct i2c_client *i2c = to_i2c_client(dev);
543 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
545 if (device_may_wakeup(dev))
546 disable_irq_wake(sec_pmic->irq);
547 enable_irq(sec_pmic->irq);
551 #endif /* CONFIG_PM_SLEEP */
553 static SIMPLE_DEV_PM_OPS(sec_pmic_pm_ops, sec_pmic_suspend, sec_pmic_resume);
555 static const struct i2c_device_id sec_pmic_id[] = {
559 MODULE_DEVICE_TABLE(i2c, sec_pmic_id);
561 static struct i2c_driver sec_pmic_driver = {
564 .pm = &sec_pmic_pm_ops,
565 .of_match_table = of_match_ptr(sec_dt_match),
567 .probe = sec_pmic_probe,
568 .shutdown = sec_pmic_shutdown,
569 .id_table = sec_pmic_id,
572 static int __init sec_pmic_init(void)
574 return i2c_add_driver(&sec_pmic_driver);
577 subsys_initcall(sec_pmic_init);
579 static void __exit sec_pmic_exit(void)
581 i2c_del_driver(&sec_pmic_driver);
583 module_exit(sec_pmic_exit);
585 MODULE_AUTHOR("Sangbeom Kim <sbkim73@samsung.com>");
586 MODULE_DESCRIPTION("Core support for the S5M MFD");
587 MODULE_LICENSE("GPL");