max77686.c 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. // SPDX-License-Identifier: GPL-2.0+
  2. //
  3. // max77686.c - mfd core driver for the Maxim 77686/802
  4. //
  5. // Copyright (C) 2012 Samsung Electronics
  6. // Chiwoong Byun <[email protected]>
  7. // Jonghwa Lee <[email protected]>
  8. //
  9. //This driver is based on max8997.c
  10. #include <linux/export.h>
  11. #include <linux/slab.h>
  12. #include <linux/i2c.h>
  13. #include <linux/irq.h>
  14. #include <linux/interrupt.h>
  15. #include <linux/pm_runtime.h>
  16. #include <linux/module.h>
  17. #include <linux/mfd/core.h>
  18. #include <linux/mfd/max77686.h>
  19. #include <linux/mfd/max77686-private.h>
  20. #include <linux/err.h>
  21. #include <linux/of.h>
  22. #include <linux/of_device.h>
  23. static const struct mfd_cell max77686_devs[] = {
  24. { .name = "max77686-pmic", },
  25. { .name = "max77686-rtc", },
  26. { .name = "max77686-clk", },
  27. };
  28. static const struct mfd_cell max77802_devs[] = {
  29. { .name = "max77802-pmic", },
  30. { .name = "max77802-clk", },
  31. { .name = "max77802-rtc", },
  32. };
  33. static bool max77802_pmic_is_accessible_reg(struct device *dev,
  34. unsigned int reg)
  35. {
  36. return reg < MAX77802_REG_PMIC_END;
  37. }
  38. static bool max77802_rtc_is_accessible_reg(struct device *dev,
  39. unsigned int reg)
  40. {
  41. return (reg >= MAX77802_RTC_INT && reg < MAX77802_RTC_END);
  42. }
  43. static bool max77802_is_accessible_reg(struct device *dev, unsigned int reg)
  44. {
  45. return (max77802_pmic_is_accessible_reg(dev, reg) ||
  46. max77802_rtc_is_accessible_reg(dev, reg));
  47. }
  48. static bool max77802_pmic_is_precious_reg(struct device *dev, unsigned int reg)
  49. {
  50. return (reg == MAX77802_REG_INTSRC || reg == MAX77802_REG_INT1 ||
  51. reg == MAX77802_REG_INT2);
  52. }
  53. static bool max77802_rtc_is_precious_reg(struct device *dev, unsigned int reg)
  54. {
  55. return (reg == MAX77802_RTC_INT ||
  56. reg == MAX77802_RTC_UPDATE0 ||
  57. reg == MAX77802_RTC_UPDATE1);
  58. }
  59. static bool max77802_is_precious_reg(struct device *dev, unsigned int reg)
  60. {
  61. return (max77802_pmic_is_precious_reg(dev, reg) ||
  62. max77802_rtc_is_precious_reg(dev, reg));
  63. }
  64. static bool max77802_pmic_is_volatile_reg(struct device *dev, unsigned int reg)
  65. {
  66. return (max77802_is_precious_reg(dev, reg) ||
  67. reg == MAX77802_REG_STATUS1 || reg == MAX77802_REG_STATUS2 ||
  68. reg == MAX77802_REG_PWRON);
  69. }
  70. static bool max77802_rtc_is_volatile_reg(struct device *dev, unsigned int reg)
  71. {
  72. return (max77802_rtc_is_precious_reg(dev, reg) ||
  73. reg == MAX77802_RTC_SEC ||
  74. reg == MAX77802_RTC_MIN ||
  75. reg == MAX77802_RTC_HOUR ||
  76. reg == MAX77802_RTC_WEEKDAY ||
  77. reg == MAX77802_RTC_MONTH ||
  78. reg == MAX77802_RTC_YEAR ||
  79. reg == MAX77802_RTC_MONTHDAY);
  80. }
  81. static bool max77802_is_volatile_reg(struct device *dev, unsigned int reg)
  82. {
  83. return (max77802_pmic_is_volatile_reg(dev, reg) ||
  84. max77802_rtc_is_volatile_reg(dev, reg));
  85. }
  86. static const struct regmap_config max77686_regmap_config = {
  87. .reg_bits = 8,
  88. .val_bits = 8,
  89. };
  90. static const struct regmap_config max77802_regmap_config = {
  91. .reg_bits = 8,
  92. .val_bits = 8,
  93. .writeable_reg = max77802_is_accessible_reg,
  94. .readable_reg = max77802_is_accessible_reg,
  95. .precious_reg = max77802_is_precious_reg,
  96. .volatile_reg = max77802_is_volatile_reg,
  97. .name = "max77802-pmic",
  98. .cache_type = REGCACHE_RBTREE,
  99. };
  100. static const struct regmap_irq max77686_irqs[] = {
  101. /* INT1 interrupts */
  102. { .reg_offset = 0, .mask = MAX77686_INT1_PWRONF_MSK, },
  103. { .reg_offset = 0, .mask = MAX77686_INT1_PWRONR_MSK, },
  104. { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBF_MSK, },
  105. { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBR_MSK, },
  106. { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBF_MSK, },
  107. { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBR_MSK, },
  108. { .reg_offset = 0, .mask = MAX77686_INT1_ONKEY1S_MSK, },
  109. { .reg_offset = 0, .mask = MAX77686_INT1_MRSTB_MSK, },
  110. /* INT2 interrupts */
  111. { .reg_offset = 1, .mask = MAX77686_INT2_140C_MSK, },
  112. { .reg_offset = 1, .mask = MAX77686_INT2_120C_MSK, },
  113. };
  114. static const struct regmap_irq_chip max77686_irq_chip = {
  115. .name = "max77686-pmic",
  116. .status_base = MAX77686_REG_INT1,
  117. .mask_base = MAX77686_REG_INT1MSK,
  118. .num_regs = 2,
  119. .irqs = max77686_irqs,
  120. .num_irqs = ARRAY_SIZE(max77686_irqs),
  121. };
  122. static const struct regmap_irq_chip max77802_irq_chip = {
  123. .name = "max77802-pmic",
  124. .status_base = MAX77802_REG_INT1,
  125. .mask_base = MAX77802_REG_INT1MSK,
  126. .num_regs = 2,
  127. .irqs = max77686_irqs, /* same masks as 77686 */
  128. .num_irqs = ARRAY_SIZE(max77686_irqs),
  129. };
  130. static const struct of_device_id max77686_pmic_dt_match[] = {
  131. {
  132. .compatible = "maxim,max77686",
  133. .data = (void *)TYPE_MAX77686,
  134. },
  135. {
  136. .compatible = "maxim,max77802",
  137. .data = (void *)TYPE_MAX77802,
  138. },
  139. { },
  140. };
  141. MODULE_DEVICE_TABLE(of, max77686_pmic_dt_match);
  142. static int max77686_i2c_probe(struct i2c_client *i2c)
  143. {
  144. struct max77686_dev *max77686 = NULL;
  145. unsigned int data;
  146. int ret = 0;
  147. const struct regmap_config *config;
  148. const struct regmap_irq_chip *irq_chip;
  149. const struct mfd_cell *cells;
  150. int n_devs;
  151. max77686 = devm_kzalloc(&i2c->dev,
  152. sizeof(struct max77686_dev), GFP_KERNEL);
  153. if (!max77686)
  154. return -ENOMEM;
  155. i2c_set_clientdata(i2c, max77686);
  156. max77686->type = (unsigned long)of_device_get_match_data(&i2c->dev);
  157. max77686->dev = &i2c->dev;
  158. max77686->i2c = i2c;
  159. max77686->irq = i2c->irq;
  160. if (max77686->type == TYPE_MAX77686) {
  161. config = &max77686_regmap_config;
  162. irq_chip = &max77686_irq_chip;
  163. cells = max77686_devs;
  164. n_devs = ARRAY_SIZE(max77686_devs);
  165. } else {
  166. config = &max77802_regmap_config;
  167. irq_chip = &max77802_irq_chip;
  168. cells = max77802_devs;
  169. n_devs = ARRAY_SIZE(max77802_devs);
  170. }
  171. max77686->regmap = devm_regmap_init_i2c(i2c, config);
  172. if (IS_ERR(max77686->regmap)) {
  173. ret = PTR_ERR(max77686->regmap);
  174. dev_err(max77686->dev, "Failed to allocate register map: %d\n",
  175. ret);
  176. return ret;
  177. }
  178. ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
  179. if (ret < 0) {
  180. dev_err(max77686->dev,
  181. "device not found on this channel (this is not an error)\n");
  182. return -ENODEV;
  183. }
  184. ret = devm_regmap_add_irq_chip(&i2c->dev, max77686->regmap,
  185. max77686->irq,
  186. IRQF_ONESHOT | IRQF_SHARED, 0, irq_chip,
  187. &max77686->irq_data);
  188. if (ret < 0) {
  189. dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
  190. return ret;
  191. }
  192. ret = devm_mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL,
  193. 0, NULL);
  194. if (ret < 0) {
  195. dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
  196. return ret;
  197. }
  198. return 0;
  199. }
  200. #ifdef CONFIG_PM_SLEEP
  201. static int max77686_suspend(struct device *dev)
  202. {
  203. struct i2c_client *i2c = to_i2c_client(dev);
  204. struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
  205. if (device_may_wakeup(dev))
  206. enable_irq_wake(max77686->irq);
  207. /*
  208. * IRQ must be disabled during suspend because if it happens
  209. * while suspended it will be handled before resuming I2C.
  210. *
  211. * When device is woken up from suspend (e.g. by RTC wake alarm),
  212. * an interrupt occurs before resuming I2C bus controller.
  213. * Interrupt handler tries to read registers but this read
  214. * will fail because I2C is still suspended.
  215. */
  216. disable_irq(max77686->irq);
  217. return 0;
  218. }
  219. static int max77686_resume(struct device *dev)
  220. {
  221. struct i2c_client *i2c = to_i2c_client(dev);
  222. struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
  223. if (device_may_wakeup(dev))
  224. disable_irq_wake(max77686->irq);
  225. enable_irq(max77686->irq);
  226. return 0;
  227. }
  228. #endif /* CONFIG_PM_SLEEP */
  229. static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);
  230. static struct i2c_driver max77686_i2c_driver = {
  231. .driver = {
  232. .name = "max77686",
  233. .pm = &max77686_pm,
  234. .of_match_table = max77686_pmic_dt_match,
  235. },
  236. .probe_new = max77686_i2c_probe,
  237. };
  238. module_i2c_driver(max77686_i2c_driver);
  239. MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
  240. MODULE_AUTHOR("Chiwoong Byun <[email protected]>");
  241. MODULE_LICENSE("GPL");