max8998.c 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. // SPDX-License-Identifier: GPL-2.0+
  2. //
  3. // max8998.c - mfd core driver for the Maxim 8998
  4. //
  5. // Copyright (C) 2009-2010 Samsung Electronics
  6. // Kyungmin Park <kyungmin.park@samsung.com>
  7. // Marek Szyprowski <m.szyprowski@samsung.com>
  8. #include <linux/err.h>
  9. #include <linux/init.h>
  10. #include <linux/slab.h>
  11. #include <linux/i2c.h>
  12. #include <linux/interrupt.h>
  13. #include <linux/of.h>
  14. #include <linux/of_irq.h>
  15. #include <linux/pm_runtime.h>
  16. #include <linux/mutex.h>
  17. #include <linux/mfd/core.h>
  18. #include <linux/mfd/max8998.h>
  19. #include <linux/mfd/max8998-private.h>
  20. #define RTC_I2C_ADDR (0x0c >> 1)
  21. static const struct mfd_cell max8998_devs[] = {
  22. {
  23. .name = "max8998-pmic",
  24. }, {
  25. .name = "max8998-rtc",
  26. }, {
  27. .name = "max8998-battery",
  28. },
  29. };
  30. static const struct mfd_cell lp3974_devs[] = {
  31. {
  32. .name = "lp3974-pmic",
  33. }, {
  34. .name = "lp3974-rtc",
  35. },
  36. };
  37. int max8998_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
  38. {
  39. struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
  40. int ret;
  41. mutex_lock(&max8998->iolock);
  42. ret = i2c_smbus_read_byte_data(i2c, reg);
  43. mutex_unlock(&max8998->iolock);
  44. if (ret < 0)
  45. return ret;
  46. ret &= 0xff;
  47. *dest = ret;
  48. return 0;
  49. }
  50. EXPORT_SYMBOL(max8998_read_reg);
  51. int max8998_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
  52. {
  53. struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
  54. int ret;
  55. mutex_lock(&max8998->iolock);
  56. ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
  57. mutex_unlock(&max8998->iolock);
  58. if (ret < 0)
  59. return ret;
  60. return 0;
  61. }
  62. EXPORT_SYMBOL(max8998_bulk_read);
  63. int max8998_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
  64. {
  65. struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
  66. int ret;
  67. mutex_lock(&max8998->iolock);
  68. ret = i2c_smbus_write_byte_data(i2c, reg, value);
  69. mutex_unlock(&max8998->iolock);
  70. return ret;
  71. }
  72. EXPORT_SYMBOL(max8998_write_reg);
  73. int max8998_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
  74. {
  75. struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
  76. int ret;
  77. mutex_lock(&max8998->iolock);
  78. ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
  79. mutex_unlock(&max8998->iolock);
  80. if (ret < 0)
  81. return ret;
  82. return 0;
  83. }
  84. EXPORT_SYMBOL(max8998_bulk_write);
  85. int max8998_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
  86. {
  87. struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
  88. int ret;
  89. mutex_lock(&max8998->iolock);
  90. ret = i2c_smbus_read_byte_data(i2c, reg);
  91. if (ret >= 0) {
  92. u8 old_val = ret & 0xff;
  93. u8 new_val = (val & mask) | (old_val & (~mask));
  94. ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
  95. }
  96. mutex_unlock(&max8998->iolock);
  97. return ret;
  98. }
  99. EXPORT_SYMBOL(max8998_update_reg);
  100. #ifdef CONFIG_OF
  101. static const struct of_device_id max8998_dt_match[] = {
  102. { .compatible = "maxim,max8998", .data = (void *)TYPE_MAX8998 },
  103. { .compatible = "national,lp3974", .data = (void *)TYPE_LP3974 },
  104. { .compatible = "ti,lp3974", .data = (void *)TYPE_LP3974 },
  105. {},
  106. };
  107. #endif
  108. /*
  109. * Only the common platform data elements for max8998 are parsed here from the
  110. * device tree. Other sub-modules of max8998 such as pmic, rtc and others have
  111. * to parse their own platform data elements from device tree.
  112. *
  113. * The max8998 platform data structure is instantiated here and the drivers for
  114. * the sub-modules need not instantiate another instance while parsing their
  115. * platform data.
  116. */
  117. static struct max8998_platform_data *max8998_i2c_parse_dt_pdata(
  118. struct device *dev)
  119. {
  120. struct max8998_platform_data *pd;
  121. pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
  122. if (!pd)
  123. return ERR_PTR(-ENOMEM);
  124. pd->ono = irq_of_parse_and_map(dev->of_node, 1);
  125. /*
  126. * ToDo: the 'wakeup' member in the platform data is more of a linux
  127. * specfic information. Hence, there is no binding for that yet and
  128. * not parsed here.
  129. */
  130. return pd;
  131. }
  132. static inline unsigned long max8998_i2c_get_driver_data(struct i2c_client *i2c,
  133. const struct i2c_device_id *id)
  134. {
  135. if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
  136. const struct of_device_id *match;
  137. match = of_match_node(max8998_dt_match, i2c->dev.of_node);
  138. return (unsigned long)match->data;
  139. }
  140. return id->driver_data;
  141. }
  142. static int max8998_i2c_probe(struct i2c_client *i2c,
  143. const struct i2c_device_id *id)
  144. {
  145. struct max8998_platform_data *pdata = dev_get_platdata(&i2c->dev);
  146. struct max8998_dev *max8998;
  147. int ret = 0;
  148. max8998 = devm_kzalloc(&i2c->dev, sizeof(struct max8998_dev),
  149. GFP_KERNEL);
  150. if (max8998 == NULL)
  151. return -ENOMEM;
  152. if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
  153. pdata = max8998_i2c_parse_dt_pdata(&i2c->dev);
  154. if (IS_ERR(pdata))
  155. return PTR_ERR(pdata);
  156. }
  157. i2c_set_clientdata(i2c, max8998);
  158. max8998->dev = &i2c->dev;
  159. max8998->i2c = i2c;
  160. max8998->irq = i2c->irq;
  161. max8998->type = max8998_i2c_get_driver_data(i2c, id);
  162. max8998->pdata = pdata;
  163. if (pdata) {
  164. max8998->ono = pdata->ono;
  165. max8998->irq_base = pdata->irq_base;
  166. max8998->wakeup = pdata->wakeup;
  167. }
  168. mutex_init(&max8998->iolock);
  169. max8998->rtc = i2c_new_dummy_device(i2c->adapter, RTC_I2C_ADDR);
  170. if (IS_ERR(max8998->rtc)) {
  171. dev_err(&i2c->dev, "Failed to allocate I2C device for RTC\n");
  172. return PTR_ERR(max8998->rtc);
  173. }
  174. i2c_set_clientdata(max8998->rtc, max8998);
  175. max8998_irq_init(max8998);
  176. pm_runtime_set_active(max8998->dev);
  177. switch (max8998->type) {
  178. case TYPE_LP3974:
  179. ret = mfd_add_devices(max8998->dev, -1,
  180. lp3974_devs, ARRAY_SIZE(lp3974_devs),
  181. NULL, 0, NULL);
  182. break;
  183. case TYPE_MAX8998:
  184. ret = mfd_add_devices(max8998->dev, -1,
  185. max8998_devs, ARRAY_SIZE(max8998_devs),
  186. NULL, 0, NULL);
  187. break;
  188. default:
  189. ret = -EINVAL;
  190. }
  191. if (ret < 0)
  192. goto err;
  193. device_init_wakeup(max8998->dev, max8998->wakeup);
  194. return ret;
  195. err:
  196. mfd_remove_devices(max8998->dev);
  197. max8998_irq_exit(max8998);
  198. i2c_unregister_device(max8998->rtc);
  199. return ret;
  200. }
  201. static const struct i2c_device_id max8998_i2c_id[] = {
  202. { "max8998", TYPE_MAX8998 },
  203. { "lp3974", TYPE_LP3974},
  204. { }
  205. };
  206. static int max8998_suspend(struct device *dev)
  207. {
  208. struct i2c_client *i2c = to_i2c_client(dev);
  209. struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
  210. if (device_may_wakeup(dev))
  211. irq_set_irq_wake(max8998->irq, 1);
  212. return 0;
  213. }
  214. static int max8998_resume(struct device *dev)
  215. {
  216. struct i2c_client *i2c = to_i2c_client(dev);
  217. struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
  218. if (device_may_wakeup(dev))
  219. irq_set_irq_wake(max8998->irq, 0);
  220. /*
  221. * In LP3974, if IRQ registers are not "read & clear"
  222. * when it's set during sleep, the interrupt becomes
  223. * disabled.
  224. */
  225. return max8998_irq_resume(i2c_get_clientdata(i2c));
  226. }
  227. struct max8998_reg_dump {
  228. u8 addr;
  229. u8 val;
  230. };
  231. #define SAVE_ITEM(x) { .addr = (x), .val = 0x0, }
  232. static struct max8998_reg_dump max8998_dump[] = {
  233. SAVE_ITEM(MAX8998_REG_IRQM1),
  234. SAVE_ITEM(MAX8998_REG_IRQM2),
  235. SAVE_ITEM(MAX8998_REG_IRQM3),
  236. SAVE_ITEM(MAX8998_REG_IRQM4),
  237. SAVE_ITEM(MAX8998_REG_STATUSM1),
  238. SAVE_ITEM(MAX8998_REG_STATUSM2),
  239. SAVE_ITEM(MAX8998_REG_CHGR1),
  240. SAVE_ITEM(MAX8998_REG_CHGR2),
  241. SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
  242. SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
  243. SAVE_ITEM(MAX8998_REG_BUCK_ACTIVE_DISCHARGE3),
  244. SAVE_ITEM(MAX8998_REG_ONOFF1),
  245. SAVE_ITEM(MAX8998_REG_ONOFF2),
  246. SAVE_ITEM(MAX8998_REG_ONOFF3),
  247. SAVE_ITEM(MAX8998_REG_ONOFF4),
  248. SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE1),
  249. SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE2),
  250. SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE3),
  251. SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE4),
  252. SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE1),
  253. SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE2),
  254. SAVE_ITEM(MAX8998_REG_LDO2_LDO3),
  255. SAVE_ITEM(MAX8998_REG_LDO4),
  256. SAVE_ITEM(MAX8998_REG_LDO5),
  257. SAVE_ITEM(MAX8998_REG_LDO6),
  258. SAVE_ITEM(MAX8998_REG_LDO7),
  259. SAVE_ITEM(MAX8998_REG_LDO8_LDO9),
  260. SAVE_ITEM(MAX8998_REG_LDO10_LDO11),
  261. SAVE_ITEM(MAX8998_REG_LDO12),
  262. SAVE_ITEM(MAX8998_REG_LDO13),
  263. SAVE_ITEM(MAX8998_REG_LDO14),
  264. SAVE_ITEM(MAX8998_REG_LDO15),
  265. SAVE_ITEM(MAX8998_REG_LDO16),
  266. SAVE_ITEM(MAX8998_REG_LDO17),
  267. SAVE_ITEM(MAX8998_REG_BKCHR),
  268. SAVE_ITEM(MAX8998_REG_LBCNFG1),
  269. SAVE_ITEM(MAX8998_REG_LBCNFG2),
  270. };
  271. /* Save registers before hibernation */
  272. static int max8998_freeze(struct device *dev)
  273. {
  274. struct i2c_client *i2c = to_i2c_client(dev);
  275. int i;
  276. for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
  277. max8998_read_reg(i2c, max8998_dump[i].addr,
  278. &max8998_dump[i].val);
  279. return 0;
  280. }
  281. /* Restore registers after hibernation */
  282. static int max8998_restore(struct device *dev)
  283. {
  284. struct i2c_client *i2c = to_i2c_client(dev);
  285. int i;
  286. for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
  287. max8998_write_reg(i2c, max8998_dump[i].addr,
  288. max8998_dump[i].val);
  289. return 0;
  290. }
  291. static const struct dev_pm_ops max8998_pm = {
  292. .suspend = max8998_suspend,
  293. .resume = max8998_resume,
  294. .freeze = max8998_freeze,
  295. .restore = max8998_restore,
  296. };
  297. static struct i2c_driver max8998_i2c_driver = {
  298. .driver = {
  299. .name = "max8998",
  300. .pm = &max8998_pm,
  301. .suppress_bind_attrs = true,
  302. .of_match_table = of_match_ptr(max8998_dt_match),
  303. },
  304. .probe = max8998_i2c_probe,
  305. .id_table = max8998_i2c_id,
  306. };
  307. static int __init max8998_i2c_init(void)
  308. {
  309. return i2c_add_driver(&max8998_i2c_driver);
  310. }
  311. /* init early so consumer devices can complete system boot */
  312. subsys_initcall(max8998_i2c_init);