xref: /rk3399_rockchip-uboot/drivers/power/regulator/regulator-uclass.c (revision 7c1937d6d1c7daf8e59b4760f8adc7ee42bd7bea)
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 int regulator_autoset(struct udevice *dev)
248 {
249 	struct dm_regulator_uclass_platdata *uc_pdata;
250 	int ret = 0;
251 
252 	uc_pdata = dev_get_uclass_platdata(dev);
253 
254 	if (uc_pdata->ramp_delay != -ENODATA)
255 		regulator_set_ramp_delay(dev, uc_pdata->ramp_delay);
256 
257 	/*
258 	 * Suspend configure is not necessary and should not influence normal
259 	 * configure, so that we set "ret=0" even failed here.
260 	 */
261 	ret = regulator_set_suspend_enable(dev, uc_pdata->suspend_on);
262 	if (!ret && uc_pdata->suspend_on)
263 		regulator_set_suspend_value(dev, uc_pdata->suspend_uV);
264 	else
265 		ret = 0;
266 
267 	if (!uc_pdata->always_on && !uc_pdata->boot_on)
268 		return -EMEDIUMTYPE;
269 
270 	if (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UV)
271 		ret = regulator_set_value(dev, uc_pdata->min_uV);
272 	if (uc_pdata->init_uV > 0) {
273 		ret = regulator_set_value(dev, uc_pdata->init_uV);
274 		if (!ret)
275 			printf("regulator(%s) init %d uV\n",
276 			       dev->name, uc_pdata->init_uV);
277 	}
278 
279 	if (!ret && (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UA))
280 		ret = regulator_set_current(dev, uc_pdata->min_uA);
281 
282 	if (!ret)
283 		ret = regulator_set_enable(dev, true);
284 
285 	return ret;
286 }
287 
288 static void regulator_show(struct udevice *dev, int ret)
289 {
290 	struct dm_regulator_uclass_platdata *uc_pdata;
291 	int uV = 0;
292 
293 	uc_pdata = dev_get_uclass_platdata(dev);
294 	uV = regulator_get_value(dev);
295 
296 	printf("%25s@%15s: ", dev->name, uc_pdata->name);
297 	printf("%7duV <-> %7duV, set %7duV, %s",
298 	       uc_pdata->min_uV, uc_pdata->max_uV, uV,
299 	       (uc_pdata->always_on || uc_pdata->boot_on) ?
300 	       "enabling" : "disabled");
301 
302 	printf(" | supsend %7duV, %s",
303 	       uc_pdata->suspend_uV,
304 	       uc_pdata->suspend_on ? "enabling" : "disabled");
305 	if (uc_pdata->init_uV != -ENODATA)
306 		printf(" ; init %7duV", uc_pdata->init_uV);
307 
308 	if (ret)
309 		printf(" (ret: %d)", ret);
310 
311 	printf("\n");
312 }
313 
314 int regulator_autoset_by_name(const char *platname, struct udevice **devp)
315 {
316 	struct udevice *dev;
317 	int ret;
318 
319 	ret = regulator_get_by_platname(platname, &dev);
320 	if (devp)
321 		*devp = dev;
322 	if (ret) {
323 		debug("Can get the regulator: %s (err=%d)\n", platname, ret);
324 		return ret;
325 	}
326 
327 	return regulator_autoset(dev);
328 }
329 
330 int regulator_list_autoset(const char *list_platname[],
331 			   struct udevice *list_devp[],
332 			   bool verbose)
333 {
334 	struct udevice *dev;
335 	int error = 0, i = 0, ret;
336 
337 	while (list_platname[i]) {
338 		ret = regulator_autoset_by_name(list_platname[i], &dev);
339 		if (ret != -EMEDIUMTYPE && verbose)
340 			regulator_show(dev, ret);
341 		if (ret & !error)
342 			error = ret;
343 
344 		if (list_devp)
345 			list_devp[i] = dev;
346 
347 		i++;
348 	}
349 
350 	return error;
351 }
352 
353 static bool regulator_name_is_unique(struct udevice *check_dev,
354 				     const char *check_name)
355 {
356 	struct dm_regulator_uclass_platdata *uc_pdata;
357 	struct udevice *dev;
358 	int check_len = strlen(check_name);
359 	int ret;
360 	int len;
361 
362 	for (ret = uclass_find_first_device(UCLASS_REGULATOR, &dev); dev;
363 	     ret = uclass_find_next_device(&dev)) {
364 		if (ret || dev == check_dev)
365 			continue;
366 
367 		uc_pdata = dev_get_uclass_platdata(dev);
368 		len = strlen(uc_pdata->name);
369 		if (len != check_len)
370 			continue;
371 
372 		if (!strcmp(uc_pdata->name, check_name))
373 			return false;
374 	}
375 
376 	return true;
377 }
378 
379 static int regulator_post_bind(struct udevice *dev)
380 {
381 	struct dm_regulator_uclass_platdata *uc_pdata;
382 	const char *property = "regulator-name";
383 
384 	uc_pdata = dev_get_uclass_platdata(dev);
385 
386 	/* Regulator's mandatory constraint */
387 	uc_pdata->name = dev_read_string(dev, property);
388 	if (!uc_pdata->name) {
389 		debug("%s: dev '%s' has no property '%s'\n",
390 		      __func__, dev->name, property);
391 		uc_pdata->name = dev_read_name(dev);
392 		if (!uc_pdata->name)
393 			return -EINVAL;
394 	}
395 
396 	if (regulator_name_is_unique(dev, uc_pdata->name))
397 		return 0;
398 
399 	debug("'%s' of dev: '%s', has nonunique value: '%s\n",
400 	      property, dev->name, uc_pdata->name);
401 
402 	return -EINVAL;
403 }
404 
405 static int regulator_pre_probe(struct udevice *dev)
406 {
407 	struct dm_regulator_uclass_platdata *uc_pdata;
408 	ofnode node;
409 
410 	uc_pdata = dev_get_uclass_platdata(dev);
411 	if (!uc_pdata)
412 		return -ENXIO;
413 
414 	/* Regulator's optional constraints */
415 	uc_pdata->min_uV = dev_read_u32_default(dev, "regulator-min-microvolt",
416 						-ENODATA);
417 	uc_pdata->max_uV = dev_read_u32_default(dev, "regulator-max-microvolt",
418 						-ENODATA);
419 	uc_pdata->init_uV = dev_read_u32_default(dev, "regulator-init-microvolt",
420 						-ENODATA);
421 	uc_pdata->min_uA = dev_read_u32_default(dev, "regulator-min-microamp",
422 						-ENODATA);
423 	uc_pdata->max_uA = dev_read_u32_default(dev, "regulator-max-microamp",
424 						-ENODATA);
425 	uc_pdata->always_on = dev_read_bool(dev, "regulator-always-on");
426 	uc_pdata->boot_on = dev_read_bool(dev, "regulator-boot-on");
427 	uc_pdata->ramp_delay = dev_read_u32_default(dev, "regulator-ramp-delay",
428 						    -ENODATA);
429 	node = dev_read_subnode(dev, "regulator-state-mem");
430 	if (ofnode_valid(node)) {
431 		uc_pdata->suspend_on = !ofnode_read_bool(node, "regulator-off-in-suspend");
432 		if (ofnode_read_u32(node, "regulator-suspend-microvolt", &uc_pdata->suspend_uV))
433 			uc_pdata->suspend_uV = uc_pdata->max_uA;
434 	} else {
435 		uc_pdata->suspend_on = true;
436 		uc_pdata->suspend_uV = uc_pdata->max_uA;
437 	}
438 
439 	/* Those values are optional (-ENODATA if unset) */
440 	if ((uc_pdata->min_uV != -ENODATA) &&
441 	    (uc_pdata->max_uV != -ENODATA) &&
442 	    (uc_pdata->min_uV == uc_pdata->max_uV))
443 		uc_pdata->flags |= REGULATOR_FLAG_AUTOSET_UV;
444 
445 	/* Those values are optional (-ENODATA if unset) */
446 	if ((uc_pdata->min_uA != -ENODATA) &&
447 	    (uc_pdata->max_uA != -ENODATA) &&
448 	    (uc_pdata->min_uA == uc_pdata->max_uA))
449 		uc_pdata->flags |= REGULATOR_FLAG_AUTOSET_UA;
450 
451 	debug("dev.name=%s: min_uV=%d, max_uV=%d, boot-on=%d, always-on=%d, "
452 	      "off-in-suspend=%d, suspend_volt=%d\n",
453 	      dev->name, uc_pdata->min_uV, uc_pdata->max_uV, uc_pdata->boot_on,
454 	      uc_pdata->always_on, !uc_pdata->suspend_on, uc_pdata->suspend_uV);
455 
456 	return 0;
457 }
458 
459 int regulators_enable_boot_on(bool verbose)
460 {
461 	struct udevice *dev;
462 	struct uclass *uc;
463 	int ret;
464 
465 	ret = uclass_get(UCLASS_REGULATOR, &uc);
466 	if (ret)
467 		return ret;
468 	for (uclass_first_device(UCLASS_REGULATOR, &dev);
469 	     dev;
470 	     uclass_next_device(&dev)) {
471 		ret = regulator_autoset(dev);
472 		if (ret == -EMEDIUMTYPE)
473 			ret = 0;
474 		if (verbose)
475 			regulator_show(dev, ret);
476 		if (ret == -ENOSYS)
477 			ret = 0;
478 	}
479 
480 	return ret;
481 }
482 
483 UCLASS_DRIVER(regulator) = {
484 	.id		= UCLASS_REGULATOR,
485 	.name		= "regulator",
486 	.post_bind	= regulator_post_bind,
487 	.pre_probe	= regulator_pre_probe,
488 	.per_device_platdata_auto_alloc_size =
489 				sizeof(struct dm_regulator_uclass_platdata),
490 };
491