1 /* 2 * sec-core.c 3 * 4 * Copyright (c) 2012 Samsung Electronics Co., Ltd 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> 20 #include <linux/of.h> 21 #include <linux/of_irq.h> 22 #include <linux/interrupt.h> 23 #include <linux/pm_runtime.h> 24 #include <linux/mutex.h> 25 #include <linux/mfd/core.h> 26 #include <linux/mfd/samsung/core.h> 27 #include <linux/mfd/samsung/irq.h> 28 #include <linux/mfd/samsung/s2mpa01.h> 29 #include <linux/mfd/samsung/s2mps11.h> 30 #include <linux/mfd/samsung/s2mps14.h> 31 #include <linux/mfd/samsung/s5m8763.h> 32 #include <linux/mfd/samsung/s5m8767.h> 33 #include <linux/regmap.h> 34 35 static const struct mfd_cell s5m8751_devs[] = { 36 { 37 .name = "s5m8751-pmic", 38 }, { 39 .name = "s5m-charger", 40 }, { 41 .name = "s5m8751-codec", 42 }, 43 }; 44 45 static const struct mfd_cell s5m8763_devs[] = { 46 { 47 .name = "s5m8763-pmic", 48 }, { 49 .name = "s5m-rtc", 50 }, { 51 .name = "s5m-charger", 52 }, 53 }; 54 55 static const struct mfd_cell s5m8767_devs[] = { 56 { 57 .name = "s5m8767-pmic", 58 }, { 59 .name = "s5m-rtc", 60 }, { 61 .name = "s5m8767-clk", 62 .of_compatible = "samsung,s5m8767-clk", 63 } 64 }; 65 66 static const struct mfd_cell s2mps11_devs[] = { 67 { 68 .name = "s2mps11-pmic", 69 }, { 70 .name = "s2mps11-clk", 71 .of_compatible = "samsung,s2mps11-clk", 72 } 73 }; 74 75 static const struct mfd_cell s2mps14_devs[] = { 76 { 77 .name = "s2mps14-pmic", 78 }, { 79 .name = "s2mps14-rtc", 80 }, { 81 .name = "s2mps14-clk", 82 .of_compatible = "samsung,s2mps14-clk", 83 } 84 }; 85 86 static const struct mfd_cell s2mpa01_devs[] = { 87 { 88 .name = "s2mpa01-pmic", 89 }, 90 }; 91 92 static const struct mfd_cell s2mpu02_devs[] = { 93 { .name = "s2mpu02-pmic", }, 94 { .name = "s2mpu02-rtc", }, 95 { 96 .name = "s2mpu02-clk", 97 .of_compatible = "samsung,s2mpu02-clk", 98 } 99 }; 100 101 #ifdef CONFIG_OF 102 static const struct of_device_id sec_dt_match[] = { 103 { .compatible = "samsung,s5m8767-pmic", 104 .data = (void *)S5M8767X, 105 }, { 106 .compatible = "samsung,s2mps11-pmic", 107 .data = (void *)S2MPS11X, 108 }, { 109 .compatible = "samsung,s2mps14-pmic", 110 .data = (void *)S2MPS14X, 111 }, { 112 .compatible = "samsung,s2mpa01-pmic", 113 .data = (void *)S2MPA01, 114 }, { 115 .compatible = "samsung,s2mpu02-pmic", 116 .data = (void *)S2MPU02, 117 }, { 118 /* Sentinel */ 119 }, 120 }; 121 #endif 122 123 static bool s2mpa01_volatile(struct device *dev, unsigned int reg) 124 { 125 switch (reg) { 126 case S2MPA01_REG_INT1M: 127 case S2MPA01_REG_INT2M: 128 case S2MPA01_REG_INT3M: 129 return false; 130 default: 131 return true; 132 } 133 } 134 135 static bool s2mps11_volatile(struct device *dev, unsigned int reg) 136 { 137 switch (reg) { 138 case S2MPS11_REG_INT1M: 139 case S2MPS11_REG_INT2M: 140 case S2MPS11_REG_INT3M: 141 return false; 142 default: 143 return true; 144 } 145 } 146 147 static bool s5m8763_volatile(struct device *dev, unsigned int reg) 148 { 149 switch (reg) { 150 case S5M8763_REG_IRQM1: 151 case S5M8763_REG_IRQM2: 152 case S5M8763_REG_IRQM3: 153 case S5M8763_REG_IRQM4: 154 return false; 155 default: 156 return true; 157 } 158 } 159 160 static const struct regmap_config sec_regmap_config = { 161 .reg_bits = 8, 162 .val_bits = 8, 163 }; 164 165 static const struct regmap_config s2mpa01_regmap_config = { 166 .reg_bits = 8, 167 .val_bits = 8, 168 169 .max_register = S2MPA01_REG_LDO_OVCB4, 170 .volatile_reg = s2mpa01_volatile, 171 .cache_type = REGCACHE_FLAT, 172 }; 173 174 static const struct regmap_config s2mps11_regmap_config = { 175 .reg_bits = 8, 176 .val_bits = 8, 177 178 .max_register = S2MPS11_REG_L38CTRL, 179 .volatile_reg = s2mps11_volatile, 180 .cache_type = REGCACHE_FLAT, 181 }; 182 183 static const struct regmap_config s2mps14_regmap_config = { 184 .reg_bits = 8, 185 .val_bits = 8, 186 187 .max_register = S2MPS14_REG_LDODSCH3, 188 .volatile_reg = s2mps11_volatile, 189 .cache_type = REGCACHE_FLAT, 190 }; 191 192 static const struct regmap_config s5m8763_regmap_config = { 193 .reg_bits = 8, 194 .val_bits = 8, 195 196 .max_register = S5M8763_REG_LBCNFG2, 197 .volatile_reg = s5m8763_volatile, 198 .cache_type = REGCACHE_FLAT, 199 }; 200 201 static const struct regmap_config s5m8767_regmap_config = { 202 .reg_bits = 8, 203 .val_bits = 8, 204 205 .max_register = S5M8767_REG_LDO28CTRL, 206 .volatile_reg = s2mps11_volatile, 207 .cache_type = REGCACHE_FLAT, 208 }; 209 210 #ifdef CONFIG_OF 211 /* 212 * Only the common platform data elements for s5m8767 are parsed here from the 213 * device tree. Other sub-modules of s5m8767 such as pmic, rtc , charger and 214 * others have to parse their own platform data elements from device tree. 215 * 216 * The s5m8767 platform data structure is instantiated here and the drivers for 217 * the sub-modules need not instantiate another instance while parsing their 218 * platform data. 219 */ 220 static struct sec_platform_data *sec_pmic_i2c_parse_dt_pdata( 221 struct device *dev) 222 { 223 struct sec_platform_data *pd; 224 225 pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL); 226 if (!pd) { 227 dev_err(dev, "could not allocate memory for pdata\n"); 228 return ERR_PTR(-ENOMEM); 229 } 230 231 /* 232 * ToDo: the 'wakeup' member in the platform data is more of a linux 233 * specfic information. Hence, there is no binding for that yet and 234 * not parsed here. 235 */ 236 237 return pd; 238 } 239 #else 240 static struct sec_platform_data *sec_pmic_i2c_parse_dt_pdata( 241 struct device *dev) 242 { 243 return NULL; 244 } 245 #endif 246 247 static inline unsigned long sec_i2c_get_driver_data(struct i2c_client *i2c, 248 const struct i2c_device_id *id) 249 { 250 #ifdef CONFIG_OF 251 if (i2c->dev.of_node) { 252 const struct of_device_id *match; 253 match = of_match_node(sec_dt_match, i2c->dev.of_node); 254 return (unsigned long)match->data; 255 } 256 #endif 257 return id->driver_data; 258 } 259 260 static int sec_pmic_probe(struct i2c_client *i2c, 261 const struct i2c_device_id *id) 262 { 263 struct sec_platform_data *pdata = dev_get_platdata(&i2c->dev); 264 const struct regmap_config *regmap; 265 const struct mfd_cell *sec_devs; 266 struct sec_pmic_dev *sec_pmic; 267 unsigned long device_type; 268 int ret, num_sec_devs; 269 270 sec_pmic = devm_kzalloc(&i2c->dev, sizeof(struct sec_pmic_dev), 271 GFP_KERNEL); 272 if (sec_pmic == NULL) 273 return -ENOMEM; 274 275 i2c_set_clientdata(i2c, sec_pmic); 276 sec_pmic->dev = &i2c->dev; 277 sec_pmic->i2c = i2c; 278 sec_pmic->irq = i2c->irq; 279 device_type = sec_i2c_get_driver_data(i2c, id); 280 281 if (sec_pmic->dev->of_node) { 282 pdata = sec_pmic_i2c_parse_dt_pdata(sec_pmic->dev); 283 if (IS_ERR(pdata)) { 284 ret = PTR_ERR(pdata); 285 return ret; 286 } 287 pdata->device_type = device_type; 288 } 289 if (pdata) { 290 sec_pmic->device_type = pdata->device_type; 291 sec_pmic->ono = pdata->ono; 292 sec_pmic->irq_base = pdata->irq_base; 293 sec_pmic->wakeup = pdata->wakeup; 294 sec_pmic->pdata = pdata; 295 } 296 297 switch (sec_pmic->device_type) { 298 case S2MPA01: 299 regmap = &s2mpa01_regmap_config; 300 break; 301 case S2MPS11X: 302 regmap = &s2mps11_regmap_config; 303 break; 304 case S2MPS14X: 305 regmap = &s2mps14_regmap_config; 306 break; 307 case S5M8763X: 308 regmap = &s5m8763_regmap_config; 309 break; 310 case S5M8767X: 311 regmap = &s5m8767_regmap_config; 312 break; 313 default: 314 regmap = &sec_regmap_config; 315 break; 316 } 317 318 sec_pmic->regmap_pmic = devm_regmap_init_i2c(i2c, regmap); 319 if (IS_ERR(sec_pmic->regmap_pmic)) { 320 ret = PTR_ERR(sec_pmic->regmap_pmic); 321 dev_err(&i2c->dev, "Failed to allocate register map: %d\n", 322 ret); 323 return ret; 324 } 325 326 if (pdata && pdata->cfg_pmic_irq) 327 pdata->cfg_pmic_irq(); 328 329 sec_irq_init(sec_pmic); 330 331 pm_runtime_set_active(sec_pmic->dev); 332 333 switch (sec_pmic->device_type) { 334 case S5M8751X: 335 sec_devs = s5m8751_devs; 336 num_sec_devs = ARRAY_SIZE(s5m8751_devs); 337 break; 338 case S5M8763X: 339 sec_devs = s5m8763_devs; 340 num_sec_devs = ARRAY_SIZE(s5m8763_devs); 341 break; 342 case S5M8767X: 343 sec_devs = s5m8767_devs; 344 num_sec_devs = ARRAY_SIZE(s5m8767_devs); 345 break; 346 case S2MPA01: 347 sec_devs = s2mpa01_devs; 348 num_sec_devs = ARRAY_SIZE(s2mpa01_devs); 349 break; 350 case S2MPS11X: 351 sec_devs = s2mps11_devs; 352 num_sec_devs = ARRAY_SIZE(s2mps11_devs); 353 break; 354 case S2MPS14X: 355 sec_devs = s2mps14_devs; 356 num_sec_devs = ARRAY_SIZE(s2mps14_devs); 357 break; 358 case S2MPU02: 359 sec_devs = s2mpu02_devs; 360 num_sec_devs = ARRAY_SIZE(s2mpu02_devs); 361 break; 362 default: 363 /* If this happens the probe function is problem */ 364 BUG(); 365 } 366 ret = mfd_add_devices(sec_pmic->dev, -1, sec_devs, num_sec_devs, NULL, 367 0, NULL); 368 if (ret) 369 goto err_mfd; 370 371 device_init_wakeup(sec_pmic->dev, sec_pmic->wakeup); 372 373 return ret; 374 375 err_mfd: 376 sec_irq_exit(sec_pmic); 377 return ret; 378 } 379 380 static int sec_pmic_remove(struct i2c_client *i2c) 381 { 382 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c); 383 384 mfd_remove_devices(sec_pmic->dev); 385 sec_irq_exit(sec_pmic); 386 return 0; 387 } 388 389 #ifdef CONFIG_PM_SLEEP 390 static int sec_pmic_suspend(struct device *dev) 391 { 392 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev); 393 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c); 394 395 if (device_may_wakeup(dev)) 396 enable_irq_wake(sec_pmic->irq); 397 /* 398 * PMIC IRQ must be disabled during suspend for RTC alarm 399 * to work properly. 400 * When device is woken up from suspend, an 401 * interrupt occurs before resuming I2C bus controller. 402 * The interrupt is handled by regmap_irq_thread which tries 403 * to read RTC registers. This read fails (I2C is still 404 * suspended) and RTC Alarm interrupt is disabled. 405 */ 406 disable_irq(sec_pmic->irq); 407 408 return 0; 409 } 410 411 static int sec_pmic_resume(struct device *dev) 412 { 413 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev); 414 struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c); 415 416 if (device_may_wakeup(dev)) 417 disable_irq_wake(sec_pmic->irq); 418 enable_irq(sec_pmic->irq); 419 420 return 0; 421 } 422 #endif /* CONFIG_PM_SLEEP */ 423 424 static SIMPLE_DEV_PM_OPS(sec_pmic_pm_ops, sec_pmic_suspend, sec_pmic_resume); 425 426 static const struct i2c_device_id sec_pmic_id[] = { 427 { "sec_pmic", 0 }, 428 { } 429 }; 430 MODULE_DEVICE_TABLE(i2c, sec_pmic_id); 431 432 static struct i2c_driver sec_pmic_driver = { 433 .driver = { 434 .name = "sec_pmic", 435 .owner = THIS_MODULE, 436 .pm = &sec_pmic_pm_ops, 437 .of_match_table = of_match_ptr(sec_dt_match), 438 }, 439 .probe = sec_pmic_probe, 440 .remove = sec_pmic_remove, 441 .id_table = sec_pmic_id, 442 }; 443 444 static int __init sec_pmic_init(void) 445 { 446 return i2c_add_driver(&sec_pmic_driver); 447 } 448 449 subsys_initcall(sec_pmic_init); 450 451 static void __exit sec_pmic_exit(void) 452 { 453 i2c_del_driver(&sec_pmic_driver); 454 } 455 module_exit(sec_pmic_exit); 456 457 MODULE_AUTHOR("Sangbeom Kim <sbkim73@samsung.com>"); 458 MODULE_DESCRIPTION("Core support for the S5M MFD"); 459 MODULE_LICENSE("GPL"); 460