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