mfd: sec-core: Dump PMIC revision to find out the HW
[linux-2.6-block.git] / drivers / mfd / sec-core.c
CommitLineData
0f5f7078 1/*
63063bfb 2 * sec-core.c
0f5f7078 3 *
63063bfb 4 * Copyright (c) 2012 Samsung Electronics Co., Ltd
0f5f7078
SK
5 * http://www.samsung.com
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version.
11 *
12 */
13
14#include <linux/module.h>
15#include <linux/moduleparam.h>
16#include <linux/init.h>
17#include <linux/err.h>
18#include <linux/slab.h>
19#include <linux/i2c.h>
1c5a099b 20#include <linux/of.h>
26aec009 21#include <linux/of_irq.h>
0f5f7078
SK
22#include <linux/interrupt.h>
23#include <linux/pm_runtime.h>
24#include <linux/mutex.h>
25#include <linux/mfd/core.h>
54227bcf
SK
26#include <linux/mfd/samsung/core.h>
27#include <linux/mfd/samsung/irq.h>
ce24991e 28#include <linux/mfd/samsung/s2mpa01.h>
25f311fa 29#include <linux/mfd/samsung/s2mps11.h>
76b9840b 30#include <linux/mfd/samsung/s2mps13.h>
dc691966 31#include <linux/mfd/samsung/s2mps14.h>
00e2573d 32#include <linux/mfd/samsung/s2mpu02.h>
25f311fa
MB
33#include <linux/mfd/samsung/s5m8763.h>
34#include <linux/mfd/samsung/s5m8767.h>
0f5f7078
SK
35#include <linux/regmap.h>
36
5ac98553 37static const struct mfd_cell s5m8751_devs[] = {
88a1cfd6
SK
38 {
39 .name = "s5m8751-pmic",
40 }, {
41 .name = "s5m-charger",
42 }, {
43 .name = "s5m8751-codec",
44 },
45};
46
5ac98553 47static const struct mfd_cell s5m8763_devs[] = {
88a1cfd6
SK
48 {
49 .name = "s5m8763-pmic",
50 }, {
51 .name = "s5m-rtc",
52 }, {
53 .name = "s5m-charger",
54 },
55};
56
5ac98553 57static const struct mfd_cell s5m8767_devs[] = {
0f5f7078
SK
58 {
59 .name = "s5m8767-pmic",
60 }, {
61 .name = "s5m-rtc",
39fed00f
TB
62 }, {
63 .name = "s5m8767-clk",
53c31b34 64 .of_compatible = "samsung,s5m8767-clk",
39fed00f 65 }
0f5f7078
SK
66};
67
5ac98553 68static const struct mfd_cell s2mps11_devs[] = {
9b6d1343
SK
69 {
70 .name = "s2mps11-pmic",
eea2e596
KK
71 }, {
72 .name = "s2mps14-rtc",
3134bcae
YSB
73 }, {
74 .name = "s2mps11-clk",
53c31b34 75 .of_compatible = "samsung,s2mps11-clk",
3134bcae 76 }
9b6d1343
SK
77};
78
3bc2ee91
CC
79static const struct mfd_cell s2mps13_devs[] = {
80 { .name = "s2mps13-pmic", },
81 { .name = "s2mps13-rtc", },
82 {
83 .name = "s2mps13-clk",
84 .of_compatible = "samsung,s2mps13-clk",
85 },
86};
87
dc691966
KK
88static const struct mfd_cell s2mps14_devs[] = {
89 {
90 .name = "s2mps14-pmic",
91 }, {
92 .name = "s2mps14-rtc",
93 }, {
94 .name = "s2mps14-clk",
53c31b34 95 .of_compatible = "samsung,s2mps14-clk",
dc691966
KK
96 }
97};
98
ce24991e
SK
99static const struct mfd_cell s2mpa01_devs[] = {
100 {
101 .name = "s2mpa01-pmic",
102 },
103};
104
54e8827d
CC
105static const struct mfd_cell s2mpu02_devs[] = {
106 { .name = "s2mpu02-pmic", },
107 { .name = "s2mpu02-rtc", },
108 {
109 .name = "s2mpu02-clk",
110 .of_compatible = "samsung,s2mpu02-clk",
111 }
112};
113
26aec009 114#ifdef CONFIG_OF
df20b7c5 115static const struct of_device_id sec_dt_match[] = {
26aec009
ADK
116 { .compatible = "samsung,s5m8767-pmic",
117 .data = (void *)S5M8767X,
ce24991e
SK
118 }, {
119 .compatible = "samsung,s2mps11-pmic",
aa32acad 120 .data = (void *)S2MPS11X,
3bc2ee91
CC
121 }, {
122 .compatible = "samsung,s2mps13-pmic",
123 .data = (void *)S2MPS13X,
ce24991e
SK
124 }, {
125 .compatible = "samsung,s2mps14-pmic",
dc691966 126 .data = (void *)S2MPS14X,
ce24991e
SK
127 }, {
128 .compatible = "samsung,s2mpa01-pmic",
129 .data = (void *)S2MPA01,
54e8827d
CC
130 }, {
131 .compatible = "samsung,s2mpu02-pmic",
132 .data = (void *)S2MPU02,
ce24991e
SK
133 }, {
134 /* Sentinel */
dc691966 135 },
26aec009
ADK
136};
137#endif
138
ce24991e
SK
139static bool s2mpa01_volatile(struct device *dev, unsigned int reg)
140{
141 switch (reg) {
142 case S2MPA01_REG_INT1M:
143 case S2MPA01_REG_INT2M:
144 case S2MPA01_REG_INT3M:
145 return false;
146 default:
147 return true;
148 }
149}
150
6b845ba9
MB
151static bool s2mps11_volatile(struct device *dev, unsigned int reg)
152{
153 switch (reg) {
154 case S2MPS11_REG_INT1M:
155 case S2MPS11_REG_INT2M:
156 case S2MPS11_REG_INT3M:
157 return false;
158 default:
159 return true;
160 }
161}
162
00e2573d
CC
163static bool s2mpu02_volatile(struct device *dev, unsigned int reg)
164{
165 switch (reg) {
166 case S2MPU02_REG_INT1M:
167 case S2MPU02_REG_INT2M:
168 case S2MPU02_REG_INT3M:
169 return false;
170 default:
171 return true;
172 }
173}
174
6b845ba9
MB
175static bool s5m8763_volatile(struct device *dev, unsigned int reg)
176{
177 switch (reg) {
178 case S5M8763_REG_IRQM1:
179 case S5M8763_REG_IRQM2:
180 case S5M8763_REG_IRQM3:
181 case S5M8763_REG_IRQM4:
182 return false;
183 default:
184 return true;
185 }
186}
187
a30fffb0 188static const struct regmap_config sec_regmap_config = {
0f5f7078
SK
189 .reg_bits = 8,
190 .val_bits = 8,
191};
192
ce24991e
SK
193static const struct regmap_config s2mpa01_regmap_config = {
194 .reg_bits = 8,
195 .val_bits = 8,
196
197 .max_register = S2MPA01_REG_LDO_OVCB4,
198 .volatile_reg = s2mpa01_volatile,
199 .cache_type = REGCACHE_FLAT,
200};
201
a30fffb0 202static const struct regmap_config s2mps11_regmap_config = {
25f311fa
MB
203 .reg_bits = 8,
204 .val_bits = 8,
205
206 .max_register = S2MPS11_REG_L38CTRL,
6b845ba9
MB
207 .volatile_reg = s2mps11_volatile,
208 .cache_type = REGCACHE_FLAT,
25f311fa
MB
209};
210
76b9840b
CC
211static const struct regmap_config s2mps13_regmap_config = {
212 .reg_bits = 8,
213 .val_bits = 8,
214
215 .max_register = S2MPS13_REG_LDODSCH5,
216 .volatile_reg = s2mps11_volatile,
217 .cache_type = REGCACHE_FLAT,
218};
219
dc691966
KK
220static const struct regmap_config s2mps14_regmap_config = {
221 .reg_bits = 8,
222 .val_bits = 8,
223
224 .max_register = S2MPS14_REG_LDODSCH3,
225 .volatile_reg = s2mps11_volatile,
226 .cache_type = REGCACHE_FLAT,
227};
228
00e2573d
CC
229static const struct regmap_config s2mpu02_regmap_config = {
230 .reg_bits = 8,
231 .val_bits = 8,
232
233 .max_register = S2MPU02_REG_DVSDATA,
234 .volatile_reg = s2mpu02_volatile,
235 .cache_type = REGCACHE_FLAT,
236};
237
a30fffb0 238static const struct regmap_config s5m8763_regmap_config = {
25f311fa
MB
239 .reg_bits = 8,
240 .val_bits = 8,
241
242 .max_register = S5M8763_REG_LBCNFG2,
6b845ba9
MB
243 .volatile_reg = s5m8763_volatile,
244 .cache_type = REGCACHE_FLAT,
25f311fa
MB
245};
246
a30fffb0 247static const struct regmap_config s5m8767_regmap_config = {
25f311fa
MB
248 .reg_bits = 8,
249 .val_bits = 8,
250
251 .max_register = S5M8767_REG_LDO28CTRL,
6b845ba9
MB
252 .volatile_reg = s2mps11_volatile,
253 .cache_type = REGCACHE_FLAT,
25f311fa 254};
26aec009 255
c2c9f1fe
KK
256static void sec_pmic_dump_rev(struct sec_pmic_dev *sec_pmic)
257{
258 unsigned int val;
259
260 /* For each device type, the REG_ID is always the first register */
261 if (!regmap_read(sec_pmic->regmap_pmic, S2MPS11_REG_ID, &val))
262 dev_dbg(sec_pmic->dev, "Revision: 0x%x\n", val);
263}
264
26aec009
ADK
265#ifdef CONFIG_OF
266/*
267 * Only the common platform data elements for s5m8767 are parsed here from the
268 * device tree. Other sub-modules of s5m8767 such as pmic, rtc , charger and
269 * others have to parse their own platform data elements from device tree.
270 *
271 * The s5m8767 platform data structure is instantiated here and the drivers for
272 * the sub-modules need not instantiate another instance while parsing their
273 * platform data.
274 */
275static struct sec_platform_data *sec_pmic_i2c_parse_dt_pdata(
276 struct device *dev)
277{
278 struct sec_platform_data *pd;
279
280 pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
82a00c49 281 if (!pd)
26aec009 282 return ERR_PTR(-ENOMEM);
26aec009
ADK
283
284 /*
285 * ToDo: the 'wakeup' member in the platform data is more of a linux
286 * specfic information. Hence, there is no binding for that yet and
287 * not parsed here.
288 */
289
d785334a
KK
290 pd->manual_poweroff = of_property_read_bool(dev->of_node,
291 "samsung,s2mps11-acokb-ground");
26aec009
ADK
292 return pd;
293}
294#else
197bf856 295static struct sec_platform_data *sec_pmic_i2c_parse_dt_pdata(
26aec009
ADK
296 struct device *dev)
297{
005718c0 298 return NULL;
26aec009
ADK
299}
300#endif
301
8f695de5 302static inline unsigned long sec_i2c_get_driver_data(struct i2c_client *i2c,
26aec009
ADK
303 const struct i2c_device_id *id)
304{
305#ifdef CONFIG_OF
306 if (i2c->dev.of_node) {
307 const struct of_device_id *match;
b6c1cb4d 308
26aec009 309 match = of_match_node(sec_dt_match, i2c->dev.of_node);
8f695de5 310 return (unsigned long)match->data;
26aec009
ADK
311 }
312#endif
8f695de5 313 return id->driver_data;
26aec009
ADK
314}
315
63063bfb 316static int sec_pmic_probe(struct i2c_client *i2c,
0f5f7078
SK
317 const struct i2c_device_id *id)
318{
334a41ce 319 struct sec_platform_data *pdata = dev_get_platdata(&i2c->dev);
e349c910 320 const struct regmap_config *regmap;
54e8827d 321 const struct mfd_cell *sec_devs;
63063bfb 322 struct sec_pmic_dev *sec_pmic;
9549b5ff 323 unsigned long device_type;
54e8827d 324 int ret, num_sec_devs;
0f5f7078 325
63063bfb 326 sec_pmic = devm_kzalloc(&i2c->dev, sizeof(struct sec_pmic_dev),
621210e2 327 GFP_KERNEL);
63063bfb 328 if (sec_pmic == NULL)
0f5f7078
SK
329 return -ENOMEM;
330
63063bfb
SK
331 i2c_set_clientdata(i2c, sec_pmic);
332 sec_pmic->dev = &i2c->dev;
333 sec_pmic->i2c = i2c;
334 sec_pmic->irq = i2c->irq;
9549b5ff 335 device_type = sec_i2c_get_driver_data(i2c, id);
26aec009
ADK
336
337 if (sec_pmic->dev->of_node) {
338 pdata = sec_pmic_i2c_parse_dt_pdata(sec_pmic->dev);
339 if (IS_ERR(pdata)) {
340 ret = PTR_ERR(pdata);
341 return ret;
342 }
9549b5ff 343 pdata->device_type = device_type;
26aec009 344 }
0f5f7078 345 if (pdata) {
63063bfb 346 sec_pmic->device_type = pdata->device_type;
63063bfb
SK
347 sec_pmic->irq_base = pdata->irq_base;
348 sec_pmic->wakeup = pdata->wakeup;
26aec009 349 sec_pmic->pdata = pdata;
0f5f7078
SK
350 }
351
25f311fa 352 switch (sec_pmic->device_type) {
ce24991e
SK
353 case S2MPA01:
354 regmap = &s2mpa01_regmap_config;
355 break;
25f311fa
MB
356 case S2MPS11X:
357 regmap = &s2mps11_regmap_config;
dc691966 358 break;
76b9840b
CC
359 case S2MPS13X:
360 regmap = &s2mps13_regmap_config;
361 break;
dc691966
KK
362 case S2MPS14X:
363 regmap = &s2mps14_regmap_config;
25f311fa
MB
364 break;
365 case S5M8763X:
366 regmap = &s5m8763_regmap_config;
367 break;
368 case S5M8767X:
369 regmap = &s5m8767_regmap_config;
370 break;
00e2573d
CC
371 case S2MPU02:
372 regmap = &s2mpu02_regmap_config;
373 break;
25f311fa
MB
374 default:
375 regmap = &sec_regmap_config;
376 break;
377 }
378
3e1e4a5f
KK
379 sec_pmic->regmap_pmic = devm_regmap_init_i2c(i2c, regmap);
380 if (IS_ERR(sec_pmic->regmap_pmic)) {
381 ret = PTR_ERR(sec_pmic->regmap_pmic);
0f5f7078 382 dev_err(&i2c->dev, "Failed to allocate register map: %d\n",
61a2af30 383 ret);
1092e1c7 384 return ret;
0f5f7078
SK
385 }
386
c3ebb30a 387 if (pdata && pdata->cfg_pmic_irq)
0f5f7078
SK
388 pdata->cfg_pmic_irq();
389
63063bfb 390 sec_irq_init(sec_pmic);
0f5f7078 391
63063bfb 392 pm_runtime_set_active(sec_pmic->dev);
0f5f7078 393
63063bfb 394 switch (sec_pmic->device_type) {
88a1cfd6 395 case S5M8751X:
54e8827d
CC
396 sec_devs = s5m8751_devs;
397 num_sec_devs = ARRAY_SIZE(s5m8751_devs);
88a1cfd6
SK
398 break;
399 case S5M8763X:
54e8827d
CC
400 sec_devs = s5m8763_devs;
401 num_sec_devs = ARRAY_SIZE(s5m8763_devs);
88a1cfd6
SK
402 break;
403 case S5M8767X:
54e8827d
CC
404 sec_devs = s5m8767_devs;
405 num_sec_devs = ARRAY_SIZE(s5m8767_devs);
88a1cfd6 406 break;
ce24991e 407 case S2MPA01:
54e8827d
CC
408 sec_devs = s2mpa01_devs;
409 num_sec_devs = ARRAY_SIZE(s2mpa01_devs);
ce24991e 410 break;
9b6d1343 411 case S2MPS11X:
54e8827d
CC
412 sec_devs = s2mps11_devs;
413 num_sec_devs = ARRAY_SIZE(s2mps11_devs);
9b6d1343 414 break;
3bc2ee91
CC
415 case S2MPS13X:
416 sec_devs = s2mps13_devs;
417 num_sec_devs = ARRAY_SIZE(s2mps13_devs);
418 break;
dc691966 419 case S2MPS14X:
54e8827d
CC
420 sec_devs = s2mps14_devs;
421 num_sec_devs = ARRAY_SIZE(s2mps14_devs);
422 break;
423 case S2MPU02:
424 sec_devs = s2mpu02_devs;
425 num_sec_devs = ARRAY_SIZE(s2mpu02_devs);
dc691966 426 break;
88a1cfd6
SK
427 default:
428 /* If this happens the probe function is problem */
429 BUG();
430 }
54e8827d
CC
431 ret = mfd_add_devices(sec_pmic->dev, -1, sec_devs, num_sec_devs, NULL,
432 0, NULL);
15447a46 433 if (ret)
8c66eece 434 goto err_mfd;
0f5f7078 435
f6d6daaf 436 device_init_wakeup(sec_pmic->dev, sec_pmic->wakeup);
c2c9f1fe 437 sec_pmic_dump_rev(sec_pmic);
f6d6daaf 438
0f5f7078
SK
439 return ret;
440
8c66eece 441err_mfd:
63063bfb 442 sec_irq_exit(sec_pmic);
0f5f7078
SK
443 return ret;
444}
445
63063bfb 446static int sec_pmic_remove(struct i2c_client *i2c)
0f5f7078 447{
63063bfb 448 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
0f5f7078 449
63063bfb
SK
450 mfd_remove_devices(sec_pmic->dev);
451 sec_irq_exit(sec_pmic);
0f5f7078
SK
452 return 0;
453}
454
d785334a
KK
455static void sec_pmic_shutdown(struct i2c_client *i2c)
456{
457 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
458 unsigned int reg, mask;
459
460 if (!sec_pmic->pdata->manual_poweroff)
461 return;
462
463 switch (sec_pmic->device_type) {
464 case S2MPS11X:
465 reg = S2MPS11_REG_CTRL1;
466 mask = S2MPS11_CTRL1_PWRHOLD_MASK;
467 break;
468 default:
469 /*
470 * Currently only one board with S2MPS11 needs this, so just
471 * ignore the rest.
472 */
473 dev_warn(sec_pmic->dev,
474 "Unsupported device %lu for manual power off\n",
475 sec_pmic->device_type);
476 return;
477 }
478
479 regmap_update_bits(sec_pmic->regmap_pmic, reg, mask, 0);
480}
481
8321bbf8 482#ifdef CONFIG_PM_SLEEP
f6d6daaf
KK
483static int sec_pmic_suspend(struct device *dev)
484{
485 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
486 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
487
360d15d6 488 if (device_may_wakeup(dev))
f6d6daaf 489 enable_irq_wake(sec_pmic->irq);
360d15d6
KK
490 /*
491 * PMIC IRQ must be disabled during suspend for RTC alarm
492 * to work properly.
493 * When device is woken up from suspend, an
494 * interrupt occurs before resuming I2C bus controller.
495 * The interrupt is handled by regmap_irq_thread which tries
496 * to read RTC registers. This read fails (I2C is still
497 * suspended) and RTC Alarm interrupt is disabled.
498 */
499 disable_irq(sec_pmic->irq);
f6d6daaf
KK
500
501 return 0;
502}
503
504static int sec_pmic_resume(struct device *dev)
505{
506 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
507 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
508
360d15d6 509 if (device_may_wakeup(dev))
f6d6daaf 510 disable_irq_wake(sec_pmic->irq);
360d15d6 511 enable_irq(sec_pmic->irq);
f6d6daaf
KK
512
513 return 0;
514}
8321bbf8 515#endif /* CONFIG_PM_SLEEP */
f6d6daaf
KK
516
517static SIMPLE_DEV_PM_OPS(sec_pmic_pm_ops, sec_pmic_suspend, sec_pmic_resume);
518
63063bfb
SK
519static const struct i2c_device_id sec_pmic_id[] = {
520 { "sec_pmic", 0 },
0f5f7078
SK
521 { }
522};
63063bfb 523MODULE_DEVICE_TABLE(i2c, sec_pmic_id);
0f5f7078 524
63063bfb 525static struct i2c_driver sec_pmic_driver = {
0f5f7078 526 .driver = {
63063bfb 527 .name = "sec_pmic",
f6d6daaf 528 .pm = &sec_pmic_pm_ops,
26aec009 529 .of_match_table = of_match_ptr(sec_dt_match),
0f5f7078 530 },
63063bfb
SK
531 .probe = sec_pmic_probe,
532 .remove = sec_pmic_remove,
d785334a 533 .shutdown = sec_pmic_shutdown,
63063bfb 534 .id_table = sec_pmic_id,
0f5f7078
SK
535};
536
63063bfb 537static int __init sec_pmic_init(void)
0f5f7078 538{
63063bfb 539 return i2c_add_driver(&sec_pmic_driver);
0f5f7078
SK
540}
541
63063bfb 542subsys_initcall(sec_pmic_init);
0f5f7078 543
63063bfb 544static void __exit sec_pmic_exit(void)
0f5f7078 545{
63063bfb 546 i2c_del_driver(&sec_pmic_driver);
0f5f7078 547}
63063bfb 548module_exit(sec_pmic_exit);
0f5f7078
SK
549
550MODULE_AUTHOR("Sangbeom Kim <sbkim73@samsung.com>");
551MODULE_DESCRIPTION("Core support for the S5M MFD");
552MODULE_LICENSE("GPL");