1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (C) 2014-2015 Samsung Electronics
4 * Przemyslaw Marczak <p.marczak@samsung.com>
5 */
6
7 #define LOG_CATEGORY UCLASS_REGULATOR
8
9 #include <errno.h>
10 #include <dm.h>
11 #include <log.h>
12 #include <dm/device_compat.h>
13 #include <dm/uclass-internal.h>
14 #include <linux/delay.h>
15 #include <power/pmic.h>
16 #include <power/regulator.h>
17
regulator_mode(struct udevice * dev,struct dm_regulator_mode ** modep)18 int regulator_mode(struct udevice *dev, struct dm_regulator_mode **modep)
19 {
20 struct dm_regulator_uclass_plat *uc_pdata;
21
22 *modep = NULL;
23
24 uc_pdata = dev_get_uclass_plat(dev);
25 if (!uc_pdata)
26 return -ENXIO;
27
28 *modep = uc_pdata->mode;
29 return uc_pdata->mode_count;
30 }
31
regulator_get_value(struct udevice * dev)32 int regulator_get_value(struct udevice *dev)
33 {
34 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
35
36 if (!ops || !ops->get_value)
37 return -ENOSYS;
38
39 return ops->get_value(dev);
40 }
41
regulator_set_value_ramp_delay(struct udevice * dev,int old_uV,int new_uV,unsigned int ramp_delay)42 static void regulator_set_value_ramp_delay(struct udevice *dev, int old_uV,
43 int new_uV, unsigned int ramp_delay)
44 {
45 int delay = DIV_ROUND_UP(abs(new_uV - old_uV), ramp_delay);
46
47 dev_dbg(dev, "delay %u us (%d uV -> %d uV)\n", delay, old_uV, new_uV);
48
49 udelay(delay);
50 }
51
regulator_set_value(struct udevice * dev,int uV)52 int regulator_set_value(struct udevice *dev, int uV)
53 {
54 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
55 struct dm_regulator_uclass_plat *uc_pdata;
56 int ret, old_uV = uV, is_enabled = 0;
57
58 if (!ops || !ops->set_value)
59 return -ENOSYS;
60
61 uc_pdata = dev_get_uclass_plat(dev);
62 if (uc_pdata->min_uV != -ENODATA && uV < uc_pdata->min_uV)
63 return -EINVAL;
64 if (uc_pdata->max_uV != -ENODATA && uV > uc_pdata->max_uV)
65 return -EINVAL;
66 if (uV == -ENODATA)
67 return -EINVAL;
68
69 if (uc_pdata->ramp_delay) {
70 is_enabled = regulator_get_enable(dev);
71 old_uV = regulator_get_value(dev);
72 }
73
74 ret = ops->set_value(dev, uV);
75
76 if (!ret) {
77 if (uc_pdata->ramp_delay && old_uV > 0 && is_enabled)
78 regulator_set_value_ramp_delay(dev, old_uV, uV,
79 uc_pdata->ramp_delay);
80 }
81
82 return ret;
83 }
84
regulator_set_suspend_value(struct udevice * dev,int uV)85 int regulator_set_suspend_value(struct udevice *dev, int uV)
86 {
87 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
88 struct dm_regulator_uclass_plat *uc_pdata;
89
90 if (!ops || !ops->set_suspend_value)
91 return -ENOSYS;
92
93 uc_pdata = dev_get_uclass_plat(dev);
94 if (uc_pdata->min_uV != -ENODATA && uV < uc_pdata->min_uV)
95 return -EINVAL;
96 if (uc_pdata->max_uV != -ENODATA && uV > uc_pdata->max_uV)
97 return -EINVAL;
98 if (uV == -ENODATA)
99 return -EINVAL;
100
101 return ops->set_suspend_value(dev, uV);
102 }
103
regulator_get_suspend_value(struct udevice * dev)104 int regulator_get_suspend_value(struct udevice *dev)
105 {
106 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
107
108 if (!ops || !ops->get_suspend_value)
109 return -ENOSYS;
110
111 return ops->get_suspend_value(dev);
112 }
113
114 /*
115 * To be called with at most caution as there is no check
116 * before setting the actual voltage value.
117 */
regulator_set_value_force(struct udevice * dev,int uV)118 int regulator_set_value_force(struct udevice *dev, int uV)
119 {
120 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
121
122 if (!ops || !ops->set_value)
123 return -ENOSYS;
124
125 return ops->set_value(dev, uV);
126 }
127
regulator_get_current(struct udevice * dev)128 int regulator_get_current(struct udevice *dev)
129 {
130 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
131
132 if (!ops || !ops->get_current)
133 return -ENOSYS;
134
135 return ops->get_current(dev);
136 }
137
regulator_set_current(struct udevice * dev,int uA)138 int regulator_set_current(struct udevice *dev, int uA)
139 {
140 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
141 struct dm_regulator_uclass_plat *uc_pdata;
142
143 if (!ops || !ops->set_current)
144 return -ENOSYS;
145
146 uc_pdata = dev_get_uclass_plat(dev);
147 if (uc_pdata->min_uA != -ENODATA && uA < uc_pdata->min_uA)
148 return -EINVAL;
149 if (uc_pdata->max_uA != -ENODATA && uA > uc_pdata->max_uA)
150 return -EINVAL;
151 if (uA == -ENODATA)
152 return -EINVAL;
153
154 return ops->set_current(dev, uA);
155 }
156
regulator_get_enable(struct udevice * dev)157 int regulator_get_enable(struct udevice *dev)
158 {
159 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
160
161 if (!ops || !ops->get_enable)
162 return -ENOSYS;
163
164 return ops->get_enable(dev);
165 }
166
regulator_set_enable(struct udevice * dev,bool enable)167 int regulator_set_enable(struct udevice *dev, bool enable)
168 {
169 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
170 struct dm_regulator_uclass_plat *uc_pdata;
171 int ret, old_enable = 0;
172
173 if (!ops || !ops->set_enable)
174 return -ENOSYS;
175
176 uc_pdata = dev_get_uclass_plat(dev);
177 if (!enable && uc_pdata->always_on)
178 return -EACCES;
179
180 if (uc_pdata->ramp_delay)
181 old_enable = regulator_get_enable(dev);
182
183 ret = ops->set_enable(dev, enable);
184 if (!ret) {
185 if (uc_pdata->ramp_delay && !old_enable && enable) {
186 int uV = regulator_get_value(dev);
187
188 if (uV > 0) {
189 regulator_set_value_ramp_delay(dev, 0, uV,
190 uc_pdata->ramp_delay);
191 }
192 }
193 }
194
195 return ret;
196 }
197
regulator_set_enable_if_allowed(struct udevice * dev,bool enable)198 int regulator_set_enable_if_allowed(struct udevice *dev, bool enable)
199 {
200 int ret;
201
202 ret = regulator_set_enable(dev, enable);
203 if (ret == -ENOSYS || ret == -EACCES)
204 return 0;
205 /* if we want to disable but it's in use by someone else */
206 if (!enable && ret == -EBUSY)
207 return 0;
208 /* if it's already enabled/disabled */
209 if (ret == -EALREADY)
210 return 0;
211
212 return ret;
213 }
214
regulator_set_suspend_enable(struct udevice * dev,bool enable)215 int regulator_set_suspend_enable(struct udevice *dev, bool enable)
216 {
217 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
218
219 if (!ops || !ops->set_suspend_enable)
220 return -ENOSYS;
221
222 return ops->set_suspend_enable(dev, enable);
223 }
224
regulator_get_suspend_enable(struct udevice * dev)225 int regulator_get_suspend_enable(struct udevice *dev)
226 {
227 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
228
229 if (!ops || !ops->get_suspend_enable)
230 return -ENOSYS;
231
232 return ops->get_suspend_enable(dev);
233 }
234
regulator_get_mode(struct udevice * dev)235 int regulator_get_mode(struct udevice *dev)
236 {
237 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
238
239 if (!ops || !ops->get_mode)
240 return -ENOSYS;
241
242 return ops->get_mode(dev);
243 }
244
regulator_set_mode(struct udevice * dev,int mode)245 int regulator_set_mode(struct udevice *dev, int mode)
246 {
247 const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
248
249 if (!ops || !ops->set_mode)
250 return -ENOSYS;
251
252 return ops->set_mode(dev, mode);
253 }
254
regulator_get_by_platname(const char * plat_name,struct udevice ** devp)255 int regulator_get_by_platname(const char *plat_name, struct udevice **devp)
256 {
257 struct dm_regulator_uclass_plat *uc_pdata;
258 struct udevice *dev;
259 int ret;
260
261 *devp = NULL;
262
263 ret = uclass_find_first_device(UCLASS_REGULATOR, &dev);
264 if (ret) {
265 dev_dbg(dev, "ret=%d\n", ret);
266 return ret;
267 }
268
269 for (; dev; uclass_find_next_device(&dev)) {
270 uc_pdata = dev_get_uclass_plat(dev);
271 if (!uc_pdata || strcmp(plat_name, uc_pdata->name))
272 continue;
273
274 return uclass_get_device_tail(dev, 0, devp);
275 }
276
277 debug("%s: can't find: %s, ret=%d\n", __func__, plat_name, ret);
278
279 return -ENODEV;
280 }
281
regulator_get_by_devname(const char * devname,struct udevice ** devp)282 int regulator_get_by_devname(const char *devname, struct udevice **devp)
283 {
284 return uclass_get_device_by_name(UCLASS_REGULATOR, devname, devp);
285 }
286
device_get_supply_regulator(struct udevice * dev,const char * supply_name,struct udevice ** devp)287 int device_get_supply_regulator(struct udevice *dev, const char *supply_name,
288 struct udevice **devp)
289 {
290 return uclass_get_device_by_phandle(UCLASS_REGULATOR, dev,
291 supply_name, devp);
292 }
293
regulator_autoset(struct udevice * dev)294 int regulator_autoset(struct udevice *dev)
295 {
296 struct dm_regulator_uclass_plat *uc_pdata;
297 int ret = 0;
298
299 uc_pdata = dev_get_uclass_plat(dev);
300
301 if (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_DONE)
302 return -EALREADY;
303
304 ret = regulator_set_suspend_enable(dev, uc_pdata->suspend_on);
305 if (ret == -ENOSYS)
306 ret = 0;
307
308 if (!ret && uc_pdata->suspend_on && uc_pdata->suspend_uV != -ENODATA) {
309 ret = regulator_set_suspend_value(dev, uc_pdata->suspend_uV);
310 if (ret == -ENOSYS)
311 ret = 0;
312
313 if (ret)
314 return ret;
315 }
316
317 if (uc_pdata->force_off) {
318 ret = regulator_set_enable(dev, false);
319 goto out;
320 }
321
322 if (!uc_pdata->always_on && !uc_pdata->boot_on) {
323 ret = -EMEDIUMTYPE;
324 goto out;
325 }
326
327 if (uc_pdata->type == REGULATOR_TYPE_FIXED) {
328 ret = regulator_set_enable(dev, true);
329 goto out;
330 }
331
332 if (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UV)
333 ret = regulator_set_value(dev, uc_pdata->min_uV);
334 if (uc_pdata->init_uV > 0)
335 ret = regulator_set_value(dev, uc_pdata->init_uV);
336 if (!ret && (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UA))
337 ret = regulator_set_current(dev, uc_pdata->min_uA);
338
339 if (!ret)
340 ret = regulator_set_enable(dev, true);
341
342 out:
343 uc_pdata->flags |= REGULATOR_FLAG_AUTOSET_DONE;
344
345 return ret;
346 }
347
regulator_show(struct udevice * dev,int ret)348 static void regulator_show(struct udevice *dev, int ret)
349 {
350 struct dm_regulator_uclass_plat *uc_pdata;
351
352 uc_pdata = dev_get_uclass_plat(dev);
353
354 printf("%s@%s: ", dev->name, uc_pdata->name);
355 if (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UV)
356 printf("set %d uV", uc_pdata->min_uV);
357 if (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UA)
358 printf("; set %d uA", uc_pdata->min_uA);
359 printf("; enabling");
360 if (ret)
361 printf(" (ret: %d)", ret);
362 printf("\n");
363 }
364
regulator_autoset_by_name(const char * platname,struct udevice ** devp)365 int regulator_autoset_by_name(const char *platname, struct udevice **devp)
366 {
367 struct udevice *dev;
368 int ret;
369
370 ret = regulator_get_by_platname(platname, &dev);
371 if (devp)
372 *devp = dev;
373 if (ret) {
374 debug("Can get the regulator: %s (err=%d)\n", platname, ret);
375 return ret;
376 }
377
378 return regulator_autoset(dev);
379 }
380
regulator_list_autoset(const char * list_platname[],struct udevice * list_devp[],bool verbose)381 int regulator_list_autoset(const char *list_platname[],
382 struct udevice *list_devp[],
383 bool verbose)
384 {
385 struct udevice *dev;
386 int error = 0, i = 0, ret;
387
388 while (list_platname[i]) {
389 ret = regulator_autoset_by_name(list_platname[i], &dev);
390 if (ret != -EMEDIUMTYPE && verbose)
391 regulator_show(dev, ret);
392 if (ret & !error)
393 error = ret;
394
395 if (list_devp)
396 list_devp[i] = dev;
397
398 i++;
399 }
400
401 return error;
402 }
403
regulator_name_is_unique(struct udevice * check_dev,const char * check_name)404 static bool regulator_name_is_unique(struct udevice *check_dev,
405 const char *check_name)
406 {
407 struct dm_regulator_uclass_plat *uc_pdata;
408 struct udevice *dev;
409 int check_len = strlen(check_name);
410 int ret;
411 int len;
412
413 ret = uclass_find_first_device(UCLASS_REGULATOR, &dev);
414 if (ret)
415 return true;
416
417 for (; dev; uclass_find_next_device(&dev)) {
418 if (dev == check_dev)
419 continue;
420
421 uc_pdata = dev_get_uclass_plat(dev);
422 len = strlen(uc_pdata->name);
423 if (len != check_len)
424 continue;
425
426 if (!strcmp(uc_pdata->name, check_name))
427 return false;
428 }
429
430 return true;
431 }
432
regulator_post_bind(struct udevice * dev)433 static int regulator_post_bind(struct udevice *dev)
434 {
435 struct dm_regulator_uclass_plat *uc_pdata;
436 const char *property = "regulator-name";
437
438 uc_pdata = dev_get_uclass_plat(dev);
439 uc_pdata->always_on = dev_read_bool(dev, "regulator-always-on");
440 uc_pdata->boot_on = dev_read_bool(dev, "regulator-boot-on");
441
442 /* Regulator's mandatory constraint */
443 uc_pdata->name = dev_read_string(dev, property);
444 if (!uc_pdata->name) {
445 dev_dbg(dev, "has no property '%s'\n", property);
446 uc_pdata->name = dev_read_name(dev);
447 if (!uc_pdata->name)
448 return -EINVAL;
449 }
450
451 if (!regulator_name_is_unique(dev, uc_pdata->name)) {
452 dev_err(dev, "'%s' has nonunique value: '%s\n",
453 property, uc_pdata->name);
454 return -EINVAL;
455 }
456
457 /*
458 * In case the regulator has regulator-always-on or
459 * regulator-boot-on DT property, trigger probe() to
460 * configure its default state during startup.
461 */
462 if (uc_pdata->always_on || uc_pdata->boot_on)
463 dev_or_flags(dev, DM_FLAG_PROBE_AFTER_BIND);
464
465 return 0;
466 }
467
regulator_pre_probe(struct udevice * dev)468 static int regulator_pre_probe(struct udevice *dev)
469 {
470 struct dm_regulator_uclass_plat *uc_pdata;
471 ofnode node;
472
473 uc_pdata = dev_get_uclass_plat(dev);
474 if (!uc_pdata)
475 return -ENXIO;
476
477 /* Regulator's optional constraints */
478 uc_pdata->min_uV = dev_read_u32_default(dev, "regulator-min-microvolt",
479 -ENODATA);
480 uc_pdata->max_uV = dev_read_u32_default(dev, "regulator-max-microvolt",
481 -ENODATA);
482 uc_pdata->init_uV = dev_read_u32_default(dev, "regulator-init-microvolt",
483 -ENODATA);
484 uc_pdata->min_uA = dev_read_u32_default(dev, "regulator-min-microamp",
485 -ENODATA);
486 uc_pdata->max_uA = dev_read_u32_default(dev, "regulator-max-microamp",
487 -ENODATA);
488 uc_pdata->ramp_delay = dev_read_u32_default(dev, "regulator-ramp-delay",
489 0);
490 uc_pdata->force_off = dev_read_bool(dev, "regulator-force-boot-off");
491
492 node = dev_read_subnode(dev, "regulator-state-mem");
493 if (ofnode_valid(node)) {
494 uc_pdata->suspend_on = !ofnode_read_bool(node, "regulator-off-in-suspend");
495 if (ofnode_read_u32(node, "regulator-suspend-microvolt", &uc_pdata->suspend_uV))
496 uc_pdata->suspend_uV = uc_pdata->max_uV;
497 } else {
498 uc_pdata->suspend_on = true;
499 uc_pdata->suspend_uV = uc_pdata->max_uV;
500 }
501
502 /* Those values are optional (-ENODATA if unset) */
503 if ((uc_pdata->min_uV != -ENODATA) &&
504 (uc_pdata->max_uV != -ENODATA) &&
505 (uc_pdata->min_uV == uc_pdata->max_uV))
506 uc_pdata->flags |= REGULATOR_FLAG_AUTOSET_UV;
507
508 /* Those values are optional (-ENODATA if unset) */
509 if ((uc_pdata->min_uA != -ENODATA) &&
510 (uc_pdata->max_uA != -ENODATA) &&
511 (uc_pdata->min_uA == uc_pdata->max_uA))
512 uc_pdata->flags |= REGULATOR_FLAG_AUTOSET_UA;
513
514 return 0;
515 }
516
regulator_post_probe(struct udevice * dev)517 static int regulator_post_probe(struct udevice *dev)
518 {
519 int ret;
520
521 ret = regulator_autoset(dev);
522 if (ret && ret != -EMEDIUMTYPE && ret != -EALREADY && ret != ENOSYS)
523 return ret;
524
525 if (_DEBUG)
526 regulator_show(dev, ret);
527
528 return 0;
529 }
530
531 UCLASS_DRIVER(regulator) = {
532 .id = UCLASS_REGULATOR,
533 .name = "regulator",
534 .post_bind = regulator_post_bind,
535 .pre_probe = regulator_pre_probe,
536 .post_probe = regulator_post_probe,
537 .per_device_plat_auto = sizeof(struct dm_regulator_uclass_plat),
538 };
539