bd71837.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Copyright (C) 2019 ROHM Semiconductors
  4. *
  5. * ROHM BD71837 regulator driver
  6. */
  7. #include <common.h>
  8. #include <dm.h>
  9. #include <log.h>
  10. #include <linux/bitops.h>
  11. #include <power/bd71837.h>
  12. #include <power/pmic.h>
  13. #include <power/regulator.h>
  14. #define HW_STATE_CONTROL 0
  15. #define DEBUG
  16. /**
  17. * struct bd71837_vrange - describe linear range of voltages
  18. *
  19. * @min_volt: smallest voltage in range
  20. * @step: how much voltage changes at each selector step
  21. * @min_sel: smallest selector in the range
  22. * @max_sel: maximum selector in the range
  23. * @rangeval: register value used to select this range if selectible
  24. * ranges are supported
  25. */
  26. struct bd71837_vrange {
  27. unsigned int min_volt;
  28. unsigned int step;
  29. u8 min_sel;
  30. u8 max_sel;
  31. u8 rangeval;
  32. };
  33. /**
  34. * struct bd71837_plat - describe regulator control registers
  35. *
  36. * @name: name of the regulator. Used for matching the dt-entry
  37. * @enable_reg: register address used to enable/disable regulator
  38. * @enablemask: register mask used to enable/disable regulator
  39. * @volt_reg: register address used to configure regulator voltage
  40. * @volt_mask: register mask used to configure regulator voltage
  41. * @ranges: pointer to ranges of regulator voltages and matching register
  42. * values
  43. * @numranges: number of voltage ranges pointed by ranges
  44. * @rangemask: mask for selecting used ranges if multiple ranges are supported
  45. * @sel_mask: bit to toggle in order to transfer the register control to SW
  46. * @dvs: whether the voltage can be changed when regulator is enabled
  47. */
  48. struct bd71837_plat {
  49. const char *name;
  50. u8 enable_reg;
  51. u8 enablemask;
  52. u8 volt_reg;
  53. u8 volt_mask;
  54. struct bd71837_vrange *ranges;
  55. unsigned int numranges;
  56. u8 rangemask;
  57. u8 sel_mask;
  58. bool dvs;
  59. };
  60. #define BD_RANGE(_min, _vstep, _sel_low, _sel_hi, _range_sel) \
  61. { \
  62. .min_volt = (_min), .step = (_vstep), .min_sel = (_sel_low), \
  63. .max_sel = (_sel_hi), .rangeval = (_range_sel) \
  64. }
  65. #define BD_DATA(_name, enreg, enmask, vreg, vmask, _range, rmask, _dvs, sel) \
  66. { \
  67. .name = (_name), .enable_reg = (enreg), .enablemask = (enmask), \
  68. .volt_reg = (vreg), .volt_mask = (vmask), .ranges = (_range), \
  69. .numranges = ARRAY_SIZE(_range), .rangemask = (rmask), .dvs = (_dvs), \
  70. .sel_mask = (sel) \
  71. }
  72. static struct bd71837_vrange dvs_buck_vranges[] = {
  73. BD_RANGE(700000, 10000, 0, 0x3c, 0),
  74. BD_RANGE(1300000, 0, 0x3d, 0x3f, 0),
  75. };
  76. static struct bd71837_vrange bd71847_buck3_vranges[] = {
  77. BD_RANGE(700000, 100000, 0x00, 0x03, 0),
  78. BD_RANGE(1050000, 50000, 0x04, 0x05, 0),
  79. BD_RANGE(1200000, 150000, 0x06, 0x07, 0),
  80. BD_RANGE(550000, 50000, 0x0, 0x7, 0x40),
  81. BD_RANGE(675000, 100000, 0x0, 0x3, 0x80),
  82. BD_RANGE(1025000, 50000, 0x4, 0x5, 0x80),
  83. BD_RANGE(1175000, 150000, 0x6, 0x7, 0x80),
  84. };
  85. static struct bd71837_vrange bd71847_buck4_vranges[] = {
  86. BD_RANGE(3000000, 100000, 0x00, 0x03, 0),
  87. BD_RANGE(2600000, 100000, 0x00, 0x03, 40),
  88. };
  89. static struct bd71837_vrange bd71837_buck5_vranges[] = {
  90. BD_RANGE(700000, 100000, 0, 0x3, 0),
  91. BD_RANGE(1050000, 50000, 0x04, 0x05, 0),
  92. BD_RANGE(1200000, 150000, 0x06, 0x07, 0),
  93. BD_RANGE(675000, 100000, 0x0, 0x3, 0x80),
  94. BD_RANGE(1025000, 50000, 0x04, 0x05, 0x80),
  95. BD_RANGE(1175000, 150000, 0x06, 0x07, 0x80),
  96. };
  97. static struct bd71837_vrange bd71837_buck6_vranges[] = {
  98. BD_RANGE(3000000, 100000, 0x00, 0x03, 0),
  99. };
  100. static struct bd71837_vrange nodvs_buck3_vranges[] = {
  101. BD_RANGE(1605000, 90000, 0, 1, 0),
  102. BD_RANGE(1755000, 45000, 2, 4, 0),
  103. BD_RANGE(1905000, 45000, 5, 7, 0),
  104. };
  105. static struct bd71837_vrange nodvs_buck4_vranges[] = {
  106. BD_RANGE(800000, 10000, 0x00, 0x3C, 0),
  107. };
  108. static struct bd71837_vrange ldo1_vranges[] = {
  109. BD_RANGE(3000000, 100000, 0x00, 0x03, 0),
  110. BD_RANGE(1600000, 100000, 0x00, 0x03, 0x20),
  111. };
  112. static struct bd71837_vrange ldo2_vranges[] = {
  113. BD_RANGE(900000, 0, 0, 0, 0),
  114. BD_RANGE(800000, 0, 1, 1, 0),
  115. };
  116. static struct bd71837_vrange ldo3_vranges[] = {
  117. BD_RANGE(1800000, 100000, 0x00, 0x0f, 0),
  118. };
  119. static struct bd71837_vrange ldo4_vranges[] = {
  120. BD_RANGE(900000, 100000, 0x00, 0x09, 0),
  121. };
  122. static struct bd71837_vrange bd71837_ldo5_vranges[] = {
  123. BD_RANGE(1800000, 100000, 0x00, 0x0f, 0),
  124. };
  125. static struct bd71837_vrange bd71847_ldo5_vranges[] = {
  126. BD_RANGE(1800000, 100000, 0x00, 0x0f, 0),
  127. BD_RANGE(800000, 100000, 0x00, 0x0f, 0x20),
  128. };
  129. static struct bd71837_vrange ldo6_vranges[] = {
  130. BD_RANGE(900000, 100000, 0x00, 0x09, 0),
  131. };
  132. static struct bd71837_vrange ldo7_vranges[] = {
  133. BD_RANGE(1800000, 100000, 0x00, 0x0f, 0),
  134. };
  135. /*
  136. * We use enable mask 'HW_STATE_CONTROL' to indicate that this regulator
  137. * must not be enabled or disabled by SW. The typical use-case for BD71837
  138. * is powering NXP i.MX8. In this use-case we (for now) only allow control
  139. * for BUCK3 and BUCK4 which are not boot critical.
  140. */
  141. static struct bd71837_plat bd71837_reg_data[] = {
  142. /* Bucks 1-4 which support dynamic voltage scaling */
  143. BD_DATA("BUCK1", BD718XX_BUCK1_CTRL, HW_STATE_CONTROL,
  144. BD718XX_BUCK1_VOLT_RUN, DVS_BUCK_RUN_MASK, dvs_buck_vranges, 0,
  145. true, BD718XX_BUCK_SEL),
  146. BD_DATA("BUCK2", BD718XX_BUCK2_CTRL, HW_STATE_CONTROL,
  147. BD718XX_BUCK2_VOLT_RUN, DVS_BUCK_RUN_MASK, dvs_buck_vranges, 0,
  148. true, BD718XX_BUCK_SEL),
  149. BD_DATA("BUCK3", BD71837_BUCK3_CTRL, BD718XX_BUCK_EN,
  150. BD71837_BUCK3_VOLT_RUN, DVS_BUCK_RUN_MASK, dvs_buck_vranges, 0,
  151. true, BD718XX_BUCK_SEL),
  152. BD_DATA("BUCK4", BD71837_BUCK4_CTRL, BD718XX_BUCK_EN,
  153. BD71837_BUCK4_VOLT_RUN, DVS_BUCK_RUN_MASK, dvs_buck_vranges, 0,
  154. true, BD718XX_BUCK_SEL),
  155. /* Bucks 5-8 which do not support dynamic voltage scaling */
  156. BD_DATA("BUCK5", BD718XX_1ST_NODVS_BUCK_CTRL, HW_STATE_CONTROL,
  157. BD718XX_1ST_NODVS_BUCK_VOLT, BD718XX_1ST_NODVS_BUCK_MASK,
  158. bd71837_buck5_vranges, 0x80, false, BD718XX_BUCK_SEL),
  159. BD_DATA("BUCK6", BD718XX_2ND_NODVS_BUCK_CTRL, HW_STATE_CONTROL,
  160. BD718XX_2ND_NODVS_BUCK_VOLT, BD71837_BUCK6_MASK,
  161. bd71837_buck6_vranges, 0, false, BD718XX_BUCK_SEL),
  162. BD_DATA("BUCK7", BD718XX_3RD_NODVS_BUCK_CTRL, HW_STATE_CONTROL,
  163. BD718XX_3RD_NODVS_BUCK_VOLT, BD718XX_3RD_NODVS_BUCK_MASK,
  164. nodvs_buck3_vranges, 0, false, BD718XX_BUCK_SEL),
  165. BD_DATA("BUCK8", BD718XX_4TH_NODVS_BUCK_CTRL, HW_STATE_CONTROL,
  166. BD718XX_4TH_NODVS_BUCK_VOLT, BD718XX_4TH_NODVS_BUCK_MASK,
  167. nodvs_buck4_vranges, 0, false, BD718XX_BUCK_SEL),
  168. /* LDOs */
  169. BD_DATA("LDO1", BD718XX_LDO1_VOLT, HW_STATE_CONTROL, BD718XX_LDO1_VOLT,
  170. BD718XX_LDO1_MASK, ldo1_vranges, 0x20, false, BD718XX_LDO_SEL),
  171. BD_DATA("LDO2", BD718XX_LDO2_VOLT, HW_STATE_CONTROL, BD718XX_LDO2_VOLT,
  172. BD718XX_LDO2_MASK, ldo2_vranges, 0, false, BD718XX_LDO_SEL),
  173. BD_DATA("LDO3", BD718XX_LDO3_VOLT, HW_STATE_CONTROL, BD718XX_LDO3_VOLT,
  174. BD718XX_LDO3_MASK, ldo3_vranges, 0, false, BD718XX_LDO_SEL),
  175. BD_DATA("LDO4", BD718XX_LDO4_VOLT, HW_STATE_CONTROL, BD718XX_LDO4_VOLT,
  176. BD718XX_LDO4_MASK, ldo4_vranges, 0, false, BD718XX_LDO_SEL),
  177. BD_DATA("LDO5", BD718XX_LDO5_VOLT, HW_STATE_CONTROL, BD718XX_LDO5_VOLT,
  178. BD71837_LDO5_MASK, bd71837_ldo5_vranges, 0, false,
  179. BD718XX_LDO_SEL),
  180. BD_DATA("LDO6", BD718XX_LDO6_VOLT, HW_STATE_CONTROL, BD718XX_LDO6_VOLT,
  181. BD718XX_LDO6_MASK, ldo6_vranges, 0, false, BD718XX_LDO_SEL),
  182. BD_DATA("LDO7", BD71837_LDO7_VOLT, HW_STATE_CONTROL, BD71837_LDO7_VOLT,
  183. BD71837_LDO7_MASK, ldo7_vranges, 0, false, BD718XX_LDO_SEL),
  184. };
  185. static struct bd71837_plat bd71847_reg_data[] = {
  186. /* Bucks 1 and 2 which support dynamic voltage scaling */
  187. BD_DATA("BUCK1", BD718XX_BUCK1_CTRL, HW_STATE_CONTROL,
  188. BD718XX_BUCK1_VOLT_RUN, DVS_BUCK_RUN_MASK, dvs_buck_vranges, 0,
  189. true, BD718XX_BUCK_SEL),
  190. BD_DATA("BUCK2", BD718XX_BUCK2_CTRL, HW_STATE_CONTROL,
  191. BD718XX_BUCK2_VOLT_RUN, DVS_BUCK_RUN_MASK, dvs_buck_vranges, 0,
  192. true, BD718XX_BUCK_SEL),
  193. /* Bucks 3-6 which do not support dynamic voltage scaling */
  194. BD_DATA("BUCK3", BD718XX_1ST_NODVS_BUCK_CTRL, HW_STATE_CONTROL,
  195. BD718XX_1ST_NODVS_BUCK_VOLT, BD718XX_1ST_NODVS_BUCK_MASK,
  196. bd71847_buck3_vranges, 0xc0, false, BD718XX_BUCK_SEL),
  197. BD_DATA("BUCK4", BD718XX_2ND_NODVS_BUCK_CTRL, HW_STATE_CONTROL,
  198. BD718XX_2ND_NODVS_BUCK_VOLT, BD71837_BUCK6_MASK,
  199. bd71847_buck4_vranges, 0x40, false, BD718XX_BUCK_SEL),
  200. BD_DATA("BUCK5", BD718XX_3RD_NODVS_BUCK_CTRL, HW_STATE_CONTROL,
  201. BD718XX_3RD_NODVS_BUCK_VOLT, BD718XX_3RD_NODVS_BUCK_MASK,
  202. nodvs_buck3_vranges, 0, false, BD718XX_BUCK_SEL),
  203. BD_DATA("BUCK6", BD718XX_4TH_NODVS_BUCK_CTRL, HW_STATE_CONTROL,
  204. BD718XX_4TH_NODVS_BUCK_VOLT, BD718XX_4TH_NODVS_BUCK_MASK,
  205. nodvs_buck4_vranges, 0, false, BD718XX_BUCK_SEL),
  206. /* LDOs */
  207. BD_DATA("LDO1", BD718XX_LDO1_VOLT, HW_STATE_CONTROL, BD718XX_LDO1_VOLT,
  208. BD718XX_LDO1_MASK, ldo1_vranges, 0x20, false, BD718XX_LDO_SEL),
  209. BD_DATA("LDO2", BD718XX_LDO2_VOLT, HW_STATE_CONTROL, BD718XX_LDO2_VOLT,
  210. BD718XX_LDO2_MASK, ldo2_vranges, 0, false, BD718XX_LDO_SEL),
  211. BD_DATA("LDO3", BD718XX_LDO3_VOLT, HW_STATE_CONTROL, BD718XX_LDO3_VOLT,
  212. BD718XX_LDO3_MASK, ldo3_vranges, 0, false, BD718XX_LDO_SEL),
  213. BD_DATA("LDO4", BD718XX_LDO4_VOLT, HW_STATE_CONTROL, BD718XX_LDO4_VOLT,
  214. BD718XX_LDO4_MASK, ldo4_vranges, 0, false, BD718XX_LDO_SEL),
  215. BD_DATA("LDO5", BD718XX_LDO5_VOLT, HW_STATE_CONTROL, BD718XX_LDO5_VOLT,
  216. BD71847_LDO5_MASK, bd71847_ldo5_vranges, 0x20, false,
  217. BD718XX_LDO_SEL),
  218. BD_DATA("LDO6", BD718XX_LDO6_VOLT, HW_STATE_CONTROL, BD718XX_LDO6_VOLT,
  219. BD718XX_LDO6_MASK, ldo6_vranges, 0, false, BD718XX_LDO_SEL),
  220. };
  221. static int vrange_find_value(struct bd71837_vrange *r, unsigned int sel,
  222. unsigned int *val)
  223. {
  224. if (!val || sel < r->min_sel || sel > r->max_sel)
  225. return -EINVAL;
  226. *val = r->min_volt + r->step * (sel - r->min_sel);
  227. return 0;
  228. }
  229. static int vrange_find_selector(struct bd71837_vrange *r, int val,
  230. unsigned int *sel)
  231. {
  232. int ret = -EINVAL;
  233. int num_vals = r->max_sel - r->min_sel + 1;
  234. if (val >= r->min_volt &&
  235. val <= r->min_volt + r->step * (num_vals - 1)) {
  236. if (r->step) {
  237. *sel = r->min_sel + ((val - r->min_volt) / r->step);
  238. ret = 0;
  239. } else {
  240. *sel = r->min_sel;
  241. ret = 0;
  242. }
  243. }
  244. return ret;
  245. }
  246. static int bd71837_get_enable(struct udevice *dev)
  247. {
  248. int val;
  249. struct bd71837_plat *plat = dev_get_plat(dev);
  250. /*
  251. * boot critical regulators on bd71837 must not be controlled by sw
  252. * due to the 'feature' which leaves power rails down if bd71837 is
  253. * reseted to snvs state. hence we can't get the state here.
  254. *
  255. * if we are alive it means we probably are on run state and
  256. * if the regulator can't be controlled we can assume it is
  257. * enabled.
  258. */
  259. if (plat->enablemask == HW_STATE_CONTROL)
  260. return 1;
  261. val = pmic_reg_read(dev->parent, plat->enable_reg);
  262. if (val < 0)
  263. return val;
  264. return (val & plat->enablemask);
  265. }
  266. static int bd71837_set_enable(struct udevice *dev, bool enable)
  267. {
  268. int val = 0;
  269. struct bd71837_plat *plat = dev_get_plat(dev);
  270. /*
  271. * boot critical regulators on bd71837 must not be controlled by sw
  272. * due to the 'feature' which leaves power rails down if bd71837 is
  273. * reseted to snvs state. Hence we can't set the state here.
  274. */
  275. if (plat->enablemask == HW_STATE_CONTROL)
  276. return -EINVAL;
  277. if (enable)
  278. val = plat->enablemask;
  279. return pmic_clrsetbits(dev->parent, plat->enable_reg, plat->enablemask,
  280. val);
  281. }
  282. static int bd71837_set_value(struct udevice *dev, int uvolt)
  283. {
  284. unsigned int sel;
  285. unsigned int range;
  286. int i;
  287. int found = 0;
  288. struct bd71837_plat *plat = dev_get_plat(dev);
  289. /*
  290. * An under/overshooting may occur if voltage is changed for other
  291. * regulators but buck 1,2,3 or 4 when regulator is enabled. Prevent
  292. * change to protect the HW
  293. */
  294. if (!plat->dvs)
  295. if (bd71837_get_enable(dev)) {
  296. pr_err("Only DVS bucks can be changed when enabled\n");
  297. return -EINVAL;
  298. }
  299. for (i = 0; i < plat->numranges; i++) {
  300. struct bd71837_vrange *r = &plat->ranges[i];
  301. found = !vrange_find_selector(r, uvolt, &sel);
  302. if (found) {
  303. unsigned int tmp;
  304. /*
  305. * We require exactly the requested value to be
  306. * supported - this can be changed later if needed
  307. */
  308. range = r->rangeval;
  309. found = !vrange_find_value(r, sel, &tmp);
  310. if (found && tmp == uvolt)
  311. break;
  312. found = 0;
  313. }
  314. }
  315. if (!found)
  316. return -EINVAL;
  317. sel <<= ffs(plat->volt_mask) - 1;
  318. if (plat->rangemask)
  319. sel |= range;
  320. return pmic_clrsetbits(dev->parent, plat->volt_reg, plat->volt_mask |
  321. plat->rangemask, sel);
  322. }
  323. static int bd71837_get_value(struct udevice *dev)
  324. {
  325. unsigned int reg, range;
  326. unsigned int tmp;
  327. struct bd71837_plat *plat = dev_get_plat(dev);
  328. int i;
  329. reg = pmic_reg_read(dev->parent, plat->volt_reg);
  330. if (((int)reg) < 0)
  331. return reg;
  332. range = reg & plat->rangemask;
  333. reg &= plat->volt_mask;
  334. reg >>= ffs(plat->volt_mask) - 1;
  335. for (i = 0; i < plat->numranges; i++) {
  336. struct bd71837_vrange *r = &plat->ranges[i];
  337. if (plat->rangemask && ((plat->rangemask & range) !=
  338. r->rangeval))
  339. continue;
  340. if (!vrange_find_value(r, reg, &tmp))
  341. return tmp;
  342. }
  343. pr_err("Unknown voltage value read from pmic\n");
  344. return -EINVAL;
  345. }
  346. static int bd71837_regulator_probe(struct udevice *dev)
  347. {
  348. struct bd71837_plat *plat = dev_get_plat(dev);
  349. int i, ret;
  350. struct dm_regulator_uclass_plat *uc_pdata;
  351. int type;
  352. struct bd71837_plat *init_data;
  353. int data_amnt;
  354. type = dev_get_driver_data(dev_get_parent(dev));
  355. switch (type) {
  356. case ROHM_CHIP_TYPE_BD71837:
  357. init_data = bd71837_reg_data;
  358. data_amnt = ARRAY_SIZE(bd71837_reg_data);
  359. break;
  360. case ROHM_CHIP_TYPE_BD71847:
  361. init_data = bd71847_reg_data;
  362. data_amnt = ARRAY_SIZE(bd71847_reg_data);
  363. break;
  364. default:
  365. debug("Unknown PMIC type\n");
  366. init_data = NULL;
  367. data_amnt = 0;
  368. break;
  369. }
  370. for (i = 0; i < data_amnt; i++) {
  371. if (!strcmp(dev->name, init_data[i].name)) {
  372. *plat = init_data[i];
  373. if (plat->enablemask != HW_STATE_CONTROL) {
  374. /*
  375. * Take the regulator under SW control. Ensure
  376. * the initial state matches dt flags and then
  377. * write the SEL bit
  378. */
  379. uc_pdata = dev_get_uclass_plat(dev);
  380. ret = bd71837_set_enable(dev,
  381. !!(uc_pdata->boot_on ||
  382. uc_pdata->always_on));
  383. if (ret)
  384. return ret;
  385. return pmic_clrsetbits(dev->parent,
  386. plat->enable_reg,
  387. plat->sel_mask,
  388. plat->sel_mask);
  389. }
  390. return 0;
  391. }
  392. }
  393. pr_err("Unknown regulator '%s'\n", dev->name);
  394. return -ENOENT;
  395. }
  396. static const struct dm_regulator_ops bd71837_regulator_ops = {
  397. .get_value = bd71837_get_value,
  398. .set_value = bd71837_set_value,
  399. .get_enable = bd71837_get_enable,
  400. .set_enable = bd71837_set_enable,
  401. };
  402. U_BOOT_DRIVER(bd71837_regulator) = {
  403. .name = BD718XX_REGULATOR_DRIVER,
  404. .id = UCLASS_REGULATOR,
  405. .ops = &bd71837_regulator_ops,
  406. .probe = bd71837_regulator_probe,
  407. .plat_auto = sizeof(struct bd71837_plat),
  408. };