max8997.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491
  1. // SPDX-License-Identifier: GPL-2.0+
  2. //
  3. // max8997.c - mfd core driver for the Maxim 8966 and 8997
  4. //
  5. // Copyright (C) 2011 Samsung Electronics
  6. // MyungJoo Ham <myungjoo.ham@samsung.com>
  7. //
  8. // This driver is based on max8998.c
  9. #include <linux/err.h>
  10. #include <linux/slab.h>
  11. #include <linux/i2c.h>
  12. #include <linux/of.h>
  13. #include <linux/of_irq.h>
  14. #include <linux/interrupt.h>
  15. #include <linux/pm_runtime.h>
  16. #include <linux/init.h>
  17. #include <linux/mutex.h>
  18. #include <linux/mfd/core.h>
  19. #include <linux/mfd/max8997.h>
  20. #include <linux/mfd/max8997-private.h>
  21. #define I2C_ADDR_PMIC (0xCC >> 1)
  22. #define I2C_ADDR_MUIC (0x4A >> 1)
  23. #define I2C_ADDR_BATTERY (0x6C >> 1)
  24. #define I2C_ADDR_RTC (0x0C >> 1)
  25. #define I2C_ADDR_HAPTIC (0x90 >> 1)
  26. static const struct mfd_cell max8997_devs[] = {
  27. { .name = "max8997-pmic", },
  28. { .name = "max8997-rtc", },
  29. { .name = "max8997-battery", },
  30. { .name = "max8997-haptic", },
  31. { .name = "max8997-muic", },
  32. { .name = "max8997-led", .id = 1 },
  33. { .name = "max8997-led", .id = 2 },
  34. };
  35. #ifdef CONFIG_OF
  36. static const struct of_device_id max8997_pmic_dt_match[] = {
  37. { .compatible = "maxim,max8997-pmic", .data = (void *)TYPE_MAX8997 },
  38. {},
  39. };
  40. #endif
  41. int max8997_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
  42. {
  43. struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  44. int ret;
  45. mutex_lock(&max8997->iolock);
  46. ret = i2c_smbus_read_byte_data(i2c, reg);
  47. mutex_unlock(&max8997->iolock);
  48. if (ret < 0)
  49. return ret;
  50. ret &= 0xff;
  51. *dest = ret;
  52. return 0;
  53. }
  54. EXPORT_SYMBOL_GPL(max8997_read_reg);
  55. int max8997_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
  56. {
  57. struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  58. int ret;
  59. mutex_lock(&max8997->iolock);
  60. ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
  61. mutex_unlock(&max8997->iolock);
  62. if (ret < 0)
  63. return ret;
  64. return 0;
  65. }
  66. EXPORT_SYMBOL_GPL(max8997_bulk_read);
  67. int max8997_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
  68. {
  69. struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  70. int ret;
  71. mutex_lock(&max8997->iolock);
  72. ret = i2c_smbus_write_byte_data(i2c, reg, value);
  73. mutex_unlock(&max8997->iolock);
  74. return ret;
  75. }
  76. EXPORT_SYMBOL_GPL(max8997_write_reg);
  77. int max8997_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
  78. {
  79. struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  80. int ret;
  81. mutex_lock(&max8997->iolock);
  82. ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
  83. mutex_unlock(&max8997->iolock);
  84. if (ret < 0)
  85. return ret;
  86. return 0;
  87. }
  88. EXPORT_SYMBOL_GPL(max8997_bulk_write);
  89. int max8997_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
  90. {
  91. struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  92. int ret;
  93. mutex_lock(&max8997->iolock);
  94. ret = i2c_smbus_read_byte_data(i2c, reg);
  95. if (ret >= 0) {
  96. u8 old_val = ret & 0xff;
  97. u8 new_val = (val & mask) | (old_val & (~mask));
  98. ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
  99. }
  100. mutex_unlock(&max8997->iolock);
  101. return ret;
  102. }
  103. EXPORT_SYMBOL_GPL(max8997_update_reg);
  104. /*
  105. * Only the common platform data elements for max8997 are parsed here from the
  106. * device tree. Other sub-modules of max8997 such as pmic, rtc and others have
  107. * to parse their own platform data elements from device tree.
  108. *
  109. * The max8997 platform data structure is instantiated here and the drivers for
  110. * the sub-modules need not instantiate another instance while parsing their
  111. * platform data.
  112. */
  113. static struct max8997_platform_data *max8997_i2c_parse_dt_pdata(
  114. struct device *dev)
  115. {
  116. struct max8997_platform_data *pd;
  117. pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
  118. if (!pd)
  119. return ERR_PTR(-ENOMEM);
  120. pd->ono = irq_of_parse_and_map(dev->of_node, 1);
  121. return pd;
  122. }
  123. static inline unsigned long max8997_i2c_get_driver_data(struct i2c_client *i2c,
  124. const struct i2c_device_id *id)
  125. {
  126. if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
  127. const struct of_device_id *match;
  128. match = of_match_node(max8997_pmic_dt_match, i2c->dev.of_node);
  129. return (unsigned long)match->data;
  130. }
  131. return id->driver_data;
  132. }
  133. static int max8997_i2c_probe(struct i2c_client *i2c,
  134. const struct i2c_device_id *id)
  135. {
  136. struct max8997_dev *max8997;
  137. struct max8997_platform_data *pdata = dev_get_platdata(&i2c->dev);
  138. int ret = 0;
  139. max8997 = devm_kzalloc(&i2c->dev, sizeof(struct max8997_dev),
  140. GFP_KERNEL);
  141. if (max8997 == NULL)
  142. return -ENOMEM;
  143. i2c_set_clientdata(i2c, max8997);
  144. max8997->dev = &i2c->dev;
  145. max8997->i2c = i2c;
  146. max8997->type = max8997_i2c_get_driver_data(i2c, id);
  147. max8997->irq = i2c->irq;
  148. if (IS_ENABLED(CONFIG_OF) && max8997->dev->of_node) {
  149. pdata = max8997_i2c_parse_dt_pdata(max8997->dev);
  150. if (IS_ERR(pdata))
  151. return PTR_ERR(pdata);
  152. }
  153. if (!pdata)
  154. return ret;
  155. max8997->pdata = pdata;
  156. max8997->ono = pdata->ono;
  157. mutex_init(&max8997->iolock);
  158. max8997->rtc = i2c_new_dummy_device(i2c->adapter, I2C_ADDR_RTC);
  159. if (IS_ERR(max8997->rtc)) {
  160. dev_err(max8997->dev, "Failed to allocate I2C device for RTC\n");
  161. return PTR_ERR(max8997->rtc);
  162. }
  163. i2c_set_clientdata(max8997->rtc, max8997);
  164. max8997->haptic = i2c_new_dummy_device(i2c->adapter, I2C_ADDR_HAPTIC);
  165. if (IS_ERR(max8997->haptic)) {
  166. dev_err(max8997->dev, "Failed to allocate I2C device for Haptic\n");
  167. ret = PTR_ERR(max8997->haptic);
  168. goto err_i2c_haptic;
  169. }
  170. i2c_set_clientdata(max8997->haptic, max8997);
  171. max8997->muic = i2c_new_dummy_device(i2c->adapter, I2C_ADDR_MUIC);
  172. if (IS_ERR(max8997->muic)) {
  173. dev_err(max8997->dev, "Failed to allocate I2C device for MUIC\n");
  174. ret = PTR_ERR(max8997->muic);
  175. goto err_i2c_muic;
  176. }
  177. i2c_set_clientdata(max8997->muic, max8997);
  178. pm_runtime_set_active(max8997->dev);
  179. max8997_irq_init(max8997);
  180. ret = mfd_add_devices(max8997->dev, -1, max8997_devs,
  181. ARRAY_SIZE(max8997_devs),
  182. NULL, 0, NULL);
  183. if (ret < 0) {
  184. dev_err(max8997->dev, "failed to add MFD devices %d\n", ret);
  185. goto err_mfd;
  186. }
  187. /*
  188. * TODO: enable others (flash, muic, rtc, battery, ...) and
  189. * check the return value
  190. */
  191. /* MAX8997 has a power button input. */
  192. device_init_wakeup(max8997->dev, true);
  193. return ret;
  194. err_mfd:
  195. mfd_remove_devices(max8997->dev);
  196. i2c_unregister_device(max8997->muic);
  197. err_i2c_muic:
  198. i2c_unregister_device(max8997->haptic);
  199. err_i2c_haptic:
  200. i2c_unregister_device(max8997->rtc);
  201. return ret;
  202. }
  203. static const struct i2c_device_id max8997_i2c_id[] = {
  204. { "max8997", TYPE_MAX8997 },
  205. { "max8966", TYPE_MAX8966 },
  206. { }
  207. };
  208. static u8 max8997_dumpaddr_pmic[] = {
  209. MAX8997_REG_INT1MSK,
  210. MAX8997_REG_INT2MSK,
  211. MAX8997_REG_INT3MSK,
  212. MAX8997_REG_INT4MSK,
  213. MAX8997_REG_MAINCON1,
  214. MAX8997_REG_MAINCON2,
  215. MAX8997_REG_BUCKRAMP,
  216. MAX8997_REG_BUCK1CTRL,
  217. MAX8997_REG_BUCK1DVS1,
  218. MAX8997_REG_BUCK1DVS2,
  219. MAX8997_REG_BUCK1DVS3,
  220. MAX8997_REG_BUCK1DVS4,
  221. MAX8997_REG_BUCK1DVS5,
  222. MAX8997_REG_BUCK1DVS6,
  223. MAX8997_REG_BUCK1DVS7,
  224. MAX8997_REG_BUCK1DVS8,
  225. MAX8997_REG_BUCK2CTRL,
  226. MAX8997_REG_BUCK2DVS1,
  227. MAX8997_REG_BUCK2DVS2,
  228. MAX8997_REG_BUCK2DVS3,
  229. MAX8997_REG_BUCK2DVS4,
  230. MAX8997_REG_BUCK2DVS5,
  231. MAX8997_REG_BUCK2DVS6,
  232. MAX8997_REG_BUCK2DVS7,
  233. MAX8997_REG_BUCK2DVS8,
  234. MAX8997_REG_BUCK3CTRL,
  235. MAX8997_REG_BUCK3DVS,
  236. MAX8997_REG_BUCK4CTRL,
  237. MAX8997_REG_BUCK4DVS,
  238. MAX8997_REG_BUCK5CTRL,
  239. MAX8997_REG_BUCK5DVS1,
  240. MAX8997_REG_BUCK5DVS2,
  241. MAX8997_REG_BUCK5DVS3,
  242. MAX8997_REG_BUCK5DVS4,
  243. MAX8997_REG_BUCK5DVS5,
  244. MAX8997_REG_BUCK5DVS6,
  245. MAX8997_REG_BUCK5DVS7,
  246. MAX8997_REG_BUCK5DVS8,
  247. MAX8997_REG_BUCK6CTRL,
  248. MAX8997_REG_BUCK6BPSKIPCTRL,
  249. MAX8997_REG_BUCK7CTRL,
  250. MAX8997_REG_BUCK7DVS,
  251. MAX8997_REG_LDO1CTRL,
  252. MAX8997_REG_LDO2CTRL,
  253. MAX8997_REG_LDO3CTRL,
  254. MAX8997_REG_LDO4CTRL,
  255. MAX8997_REG_LDO5CTRL,
  256. MAX8997_REG_LDO6CTRL,
  257. MAX8997_REG_LDO7CTRL,
  258. MAX8997_REG_LDO8CTRL,
  259. MAX8997_REG_LDO9CTRL,
  260. MAX8997_REG_LDO10CTRL,
  261. MAX8997_REG_LDO11CTRL,
  262. MAX8997_REG_LDO12CTRL,
  263. MAX8997_REG_LDO13CTRL,
  264. MAX8997_REG_LDO14CTRL,
  265. MAX8997_REG_LDO15CTRL,
  266. MAX8997_REG_LDO16CTRL,
  267. MAX8997_REG_LDO17CTRL,
  268. MAX8997_REG_LDO18CTRL,
  269. MAX8997_REG_LDO21CTRL,
  270. MAX8997_REG_MBCCTRL1,
  271. MAX8997_REG_MBCCTRL2,
  272. MAX8997_REG_MBCCTRL3,
  273. MAX8997_REG_MBCCTRL4,
  274. MAX8997_REG_MBCCTRL5,
  275. MAX8997_REG_MBCCTRL6,
  276. MAX8997_REG_OTPCGHCVS,
  277. MAX8997_REG_SAFEOUTCTRL,
  278. MAX8997_REG_LBCNFG1,
  279. MAX8997_REG_LBCNFG2,
  280. MAX8997_REG_BBCCTRL,
  281. MAX8997_REG_FLASH1_CUR,
  282. MAX8997_REG_FLASH2_CUR,
  283. MAX8997_REG_MOVIE_CUR,
  284. MAX8997_REG_GSMB_CUR,
  285. MAX8997_REG_BOOST_CNTL,
  286. MAX8997_REG_LEN_CNTL,
  287. MAX8997_REG_FLASH_CNTL,
  288. MAX8997_REG_WDT_CNTL,
  289. MAX8997_REG_MAXFLASH1,
  290. MAX8997_REG_MAXFLASH2,
  291. MAX8997_REG_FLASHSTATUSMASK,
  292. MAX8997_REG_GPIOCNTL1,
  293. MAX8997_REG_GPIOCNTL2,
  294. MAX8997_REG_GPIOCNTL3,
  295. MAX8997_REG_GPIOCNTL4,
  296. MAX8997_REG_GPIOCNTL5,
  297. MAX8997_REG_GPIOCNTL6,
  298. MAX8997_REG_GPIOCNTL7,
  299. MAX8997_REG_GPIOCNTL8,
  300. MAX8997_REG_GPIOCNTL9,
  301. MAX8997_REG_GPIOCNTL10,
  302. MAX8997_REG_GPIOCNTL11,
  303. MAX8997_REG_GPIOCNTL12,
  304. MAX8997_REG_LDO1CONFIG,
  305. MAX8997_REG_LDO2CONFIG,
  306. MAX8997_REG_LDO3CONFIG,
  307. MAX8997_REG_LDO4CONFIG,
  308. MAX8997_REG_LDO5CONFIG,
  309. MAX8997_REG_LDO6CONFIG,
  310. MAX8997_REG_LDO7CONFIG,
  311. MAX8997_REG_LDO8CONFIG,
  312. MAX8997_REG_LDO9CONFIG,
  313. MAX8997_REG_LDO10CONFIG,
  314. MAX8997_REG_LDO11CONFIG,
  315. MAX8997_REG_LDO12CONFIG,
  316. MAX8997_REG_LDO13CONFIG,
  317. MAX8997_REG_LDO14CONFIG,
  318. MAX8997_REG_LDO15CONFIG,
  319. MAX8997_REG_LDO16CONFIG,
  320. MAX8997_REG_LDO17CONFIG,
  321. MAX8997_REG_LDO18CONFIG,
  322. MAX8997_REG_LDO21CONFIG,
  323. MAX8997_REG_DVSOKTIMER1,
  324. MAX8997_REG_DVSOKTIMER2,
  325. MAX8997_REG_DVSOKTIMER4,
  326. MAX8997_REG_DVSOKTIMER5,
  327. };
  328. static u8 max8997_dumpaddr_muic[] = {
  329. MAX8997_MUIC_REG_INTMASK1,
  330. MAX8997_MUIC_REG_INTMASK2,
  331. MAX8997_MUIC_REG_INTMASK3,
  332. MAX8997_MUIC_REG_CDETCTRL,
  333. MAX8997_MUIC_REG_CONTROL1,
  334. MAX8997_MUIC_REG_CONTROL2,
  335. MAX8997_MUIC_REG_CONTROL3,
  336. };
  337. static u8 max8997_dumpaddr_haptic[] = {
  338. MAX8997_HAPTIC_REG_CONF1,
  339. MAX8997_HAPTIC_REG_CONF2,
  340. MAX8997_HAPTIC_REG_DRVCONF,
  341. MAX8997_HAPTIC_REG_CYCLECONF1,
  342. MAX8997_HAPTIC_REG_CYCLECONF2,
  343. MAX8997_HAPTIC_REG_SIGCONF1,
  344. MAX8997_HAPTIC_REG_SIGCONF2,
  345. MAX8997_HAPTIC_REG_SIGCONF3,
  346. MAX8997_HAPTIC_REG_SIGCONF4,
  347. MAX8997_HAPTIC_REG_SIGDC1,
  348. MAX8997_HAPTIC_REG_SIGDC2,
  349. MAX8997_HAPTIC_REG_SIGPWMDC1,
  350. MAX8997_HAPTIC_REG_SIGPWMDC2,
  351. MAX8997_HAPTIC_REG_SIGPWMDC3,
  352. MAX8997_HAPTIC_REG_SIGPWMDC4,
  353. };
  354. static int max8997_freeze(struct device *dev)
  355. {
  356. struct i2c_client *i2c = to_i2c_client(dev);
  357. struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  358. int i;
  359. for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
  360. max8997_read_reg(i2c, max8997_dumpaddr_pmic[i],
  361. &max8997->reg_dump[i]);
  362. for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
  363. max8997_read_reg(i2c, max8997_dumpaddr_muic[i],
  364. &max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
  365. for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
  366. max8997_read_reg(i2c, max8997_dumpaddr_haptic[i],
  367. &max8997->reg_dump[i + MAX8997_REG_PMIC_END +
  368. MAX8997_MUIC_REG_END]);
  369. return 0;
  370. }
  371. static int max8997_restore(struct device *dev)
  372. {
  373. struct i2c_client *i2c = to_i2c_client(dev);
  374. struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  375. int i;
  376. for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
  377. max8997_write_reg(i2c, max8997_dumpaddr_pmic[i],
  378. max8997->reg_dump[i]);
  379. for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
  380. max8997_write_reg(i2c, max8997_dumpaddr_muic[i],
  381. max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
  382. for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
  383. max8997_write_reg(i2c, max8997_dumpaddr_haptic[i],
  384. max8997->reg_dump[i + MAX8997_REG_PMIC_END +
  385. MAX8997_MUIC_REG_END]);
  386. return 0;
  387. }
  388. static int max8997_suspend(struct device *dev)
  389. {
  390. struct i2c_client *i2c = to_i2c_client(dev);
  391. struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  392. disable_irq(max8997->irq);
  393. if (device_may_wakeup(dev))
  394. irq_set_irq_wake(max8997->irq, 1);
  395. return 0;
  396. }
  397. static int max8997_resume(struct device *dev)
  398. {
  399. struct i2c_client *i2c = to_i2c_client(dev);
  400. struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
  401. if (device_may_wakeup(dev))
  402. irq_set_irq_wake(max8997->irq, 0);
  403. enable_irq(max8997->irq);
  404. return max8997_irq_resume(max8997);
  405. }
  406. static const struct dev_pm_ops max8997_pm = {
  407. .suspend = max8997_suspend,
  408. .resume = max8997_resume,
  409. .freeze = max8997_freeze,
  410. .restore = max8997_restore,
  411. };
  412. static struct i2c_driver max8997_i2c_driver = {
  413. .driver = {
  414. .name = "max8997",
  415. .pm = &max8997_pm,
  416. .suppress_bind_attrs = true,
  417. .of_match_table = of_match_ptr(max8997_pmic_dt_match),
  418. },
  419. .probe = max8997_i2c_probe,
  420. .id_table = max8997_i2c_id,
  421. };
  422. static int __init max8997_i2c_init(void)
  423. {
  424. return i2c_add_driver(&max8997_i2c_driver);
  425. }
  426. /* init early so consumer devices can complete system boot */
  427. subsys_initcall(max8997_i2c_init);