xref: /rk3399_rockchip-uboot/drivers/power/regulator/regulator-uclass.c (revision e17ddcea32b2fa7b82fb079f37195855a55e39a2)
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 
46 	uc_pdata = dev_get_uclass_platdata(dev);
47 	if (uc_pdata->min_uV != -ENODATA && uV < uc_pdata->min_uV)
48 		return -EINVAL;
49 	if (uc_pdata->max_uV != -ENODATA && uV > uc_pdata->max_uV)
50 		return -EINVAL;
51 
52 	if (!ops || !ops->set_value)
53 		return -ENOSYS;
54 
55 	return ops->set_value(dev, uV);
56 }
57 
58 int regulator_set_suspend_value(struct udevice *dev, int uV)
59 {
60 	const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
61 
62 	if (!ops || !ops->set_suspend_value)
63 		return -ENOSYS;
64 
65 	return ops->set_suspend_value(dev, uV);
66 }
67 
68 /*
69  * To be called with at most caution as there is no check
70  * before setting the actual voltage value.
71  */
72 int regulator_set_value_force(struct udevice *dev, int uV)
73 {
74 	const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
75 
76 	if (!ops || !ops->set_value)
77 		return -ENOSYS;
78 
79 	return ops->set_value(dev, uV);
80 }
81 
82 int regulator_get_current(struct udevice *dev)
83 {
84 	const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
85 
86 	if (!ops || !ops->get_current)
87 		return -ENOSYS;
88 
89 	return ops->get_current(dev);
90 }
91 
92 int regulator_set_current(struct udevice *dev, int uA)
93 {
94 	const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
95 	struct dm_regulator_uclass_platdata *uc_pdata;
96 
97 	uc_pdata = dev_get_uclass_platdata(dev);
98 	if (uc_pdata->min_uA != -ENODATA && uA < uc_pdata->min_uA)
99 		return -EINVAL;
100 	if (uc_pdata->max_uA != -ENODATA && uA > uc_pdata->max_uA)
101 		return -EINVAL;
102 
103 	if (!ops || !ops->set_current)
104 		return -ENOSYS;
105 
106 	return ops->set_current(dev, uA);
107 }
108 
109 int regulator_get_enable(struct udevice *dev)
110 {
111 	const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
112 
113 	if (!ops || !ops->get_enable)
114 		return -ENOSYS;
115 
116 	return ops->get_enable(dev);
117 }
118 
119 int regulator_set_enable(struct udevice *dev, bool enable)
120 {
121 	const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
122 
123 	if (!ops || !ops->set_enable)
124 		return -ENOSYS;
125 
126 	return ops->set_enable(dev, enable);
127 }
128 
129 int regulator_set_suspend_enable(struct udevice *dev, bool enable)
130 {
131 	const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
132 
133 	if (!ops || !ops->set_suspend_enable)
134 		return -ENOSYS;
135 
136 	return ops->set_suspend_enable(dev, enable);
137 }
138 
139 int regulator_get_mode(struct udevice *dev)
140 {
141 	const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
142 
143 	if (!ops || !ops->get_mode)
144 		return -ENOSYS;
145 
146 	return ops->get_mode(dev);
147 }
148 
149 int regulator_set_mode(struct udevice *dev, int mode)
150 {
151 	const struct dm_regulator_ops *ops = dev_get_driver_ops(dev);
152 
153 	if (!ops || !ops->set_mode)
154 		return -ENOSYS;
155 
156 	return ops->set_mode(dev, mode);
157 }
158 
159 int regulator_get_by_platname(const char *plat_name, struct udevice **devp)
160 {
161 	struct dm_regulator_uclass_platdata *uc_pdata;
162 	struct udevice *dev;
163 	int ret;
164 
165 	*devp = NULL;
166 
167 	for (ret = uclass_find_first_device(UCLASS_REGULATOR, &dev); dev;
168 	     ret = uclass_find_next_device(&dev)) {
169 		if (ret) {
170 			debug("regulator %s, ret=%d\n", dev->name, ret);
171 			continue;
172 		}
173 
174 		uc_pdata = dev_get_uclass_platdata(dev);
175 		if (!uc_pdata || strcmp(plat_name, uc_pdata->name))
176 			continue;
177 
178 		return uclass_get_device_tail(dev, 0, devp);
179 	}
180 
181 	debug("%s: can't find: %s, ret=%d\n", __func__, plat_name, ret);
182 
183 	return -ENODEV;
184 }
185 
186 int regulator_get_by_devname(const char *devname, struct udevice **devp)
187 {
188 	return uclass_get_device_by_name(UCLASS_REGULATOR, devname, devp);
189 }
190 
191 int device_get_supply_regulator(struct udevice *dev, const char *supply_name,
192 				struct udevice **devp)
193 {
194 	return uclass_get_device_by_phandle(UCLASS_REGULATOR, dev,
195 					    supply_name, devp);
196 }
197 
198 int regulator_autoset(struct udevice *dev)
199 {
200 	struct dm_regulator_uclass_platdata *uc_pdata;
201 	int ret = 0;
202 
203 	uc_pdata = dev_get_uclass_platdata(dev);
204 
205 	ret = regulator_set_suspend_enable(dev, uc_pdata->suspend_on);
206 	if (!ret && uc_pdata->suspend_on)
207 		ret = regulator_set_suspend_value(dev, uc_pdata->suspend_uV);
208 
209 	if (!uc_pdata->always_on && !uc_pdata->boot_on)
210 		return -EMEDIUMTYPE;
211 
212 	if (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UV)
213 		ret = regulator_set_value(dev, uc_pdata->min_uV);
214 	if (uc_pdata->init_uV > 0)
215 		ret = regulator_set_value(dev, uc_pdata->init_uV);
216 	if (!ret && (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UA))
217 		ret = regulator_set_current(dev, uc_pdata->min_uA);
218 
219 	if (!ret)
220 		ret = regulator_set_enable(dev, true);
221 
222 	return ret;
223 }
224 
225 static void regulator_show(struct udevice *dev, int ret)
226 {
227 	struct dm_regulator_uclass_platdata *uc_pdata;
228 
229 	uc_pdata = dev_get_uclass_platdata(dev);
230 
231 	printf("%s@%s: ", dev->name, uc_pdata->name);
232 	if (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UV)
233 		printf("set %d uV", uc_pdata->min_uV);
234 	if (uc_pdata->flags & REGULATOR_FLAG_AUTOSET_UA)
235 		printf("; set %d uA", uc_pdata->min_uA);
236 	printf("; enabling");
237 	if (ret)
238 		printf(" (ret: %d)", ret);
239 	printf("\n");
240 }
241 
242 int regulator_autoset_by_name(const char *platname, struct udevice **devp)
243 {
244 	struct udevice *dev;
245 	int ret;
246 
247 	ret = regulator_get_by_platname(platname, &dev);
248 	if (devp)
249 		*devp = dev;
250 	if (ret) {
251 		debug("Can get the regulator: %s (err=%d)\n", platname, ret);
252 		return ret;
253 	}
254 
255 	return regulator_autoset(dev);
256 }
257 
258 int regulator_list_autoset(const char *list_platname[],
259 			   struct udevice *list_devp[],
260 			   bool verbose)
261 {
262 	struct udevice *dev;
263 	int error = 0, i = 0, ret;
264 
265 	while (list_platname[i]) {
266 		ret = regulator_autoset_by_name(list_platname[i], &dev);
267 		if (ret != -EMEDIUMTYPE && verbose)
268 			regulator_show(dev, ret);
269 		if (ret & !error)
270 			error = ret;
271 
272 		if (list_devp)
273 			list_devp[i] = dev;
274 
275 		i++;
276 	}
277 
278 	return error;
279 }
280 
281 static bool regulator_name_is_unique(struct udevice *check_dev,
282 				     const char *check_name)
283 {
284 	struct dm_regulator_uclass_platdata *uc_pdata;
285 	struct udevice *dev;
286 	int check_len = strlen(check_name);
287 	int ret;
288 	int len;
289 
290 	for (ret = uclass_find_first_device(UCLASS_REGULATOR, &dev); dev;
291 	     ret = uclass_find_next_device(&dev)) {
292 		if (ret || dev == check_dev)
293 			continue;
294 
295 		uc_pdata = dev_get_uclass_platdata(dev);
296 		len = strlen(uc_pdata->name);
297 		if (len != check_len)
298 			continue;
299 
300 		if (!strcmp(uc_pdata->name, check_name))
301 			return false;
302 	}
303 
304 	return true;
305 }
306 
307 static int regulator_post_bind(struct udevice *dev)
308 {
309 	struct dm_regulator_uclass_platdata *uc_pdata;
310 	const char *property = "regulator-name";
311 
312 	uc_pdata = dev_get_uclass_platdata(dev);
313 
314 	/* Regulator's mandatory constraint */
315 	uc_pdata->name = dev_read_string(dev, property);
316 	if (!uc_pdata->name) {
317 		debug("%s: dev '%s' has no property '%s'\n",
318 		      __func__, dev->name, property);
319 		uc_pdata->name = dev_read_name(dev);
320 		if (!uc_pdata->name)
321 			return -EINVAL;
322 	}
323 
324 	if (regulator_name_is_unique(dev, uc_pdata->name))
325 		return 0;
326 
327 	debug("'%s' of dev: '%s', has nonunique value: '%s\n",
328 	      property, dev->name, uc_pdata->name);
329 
330 	return -EINVAL;
331 }
332 
333 static int regulator_pre_probe(struct udevice *dev)
334 {
335 	struct dm_regulator_uclass_platdata *uc_pdata;
336 	ofnode node;
337 
338 	uc_pdata = dev_get_uclass_platdata(dev);
339 	if (!uc_pdata)
340 		return -ENXIO;
341 
342 	/* Regulator's optional constraints */
343 	uc_pdata->min_uV = dev_read_u32_default(dev, "regulator-min-microvolt",
344 						-ENODATA);
345 	uc_pdata->max_uV = dev_read_u32_default(dev, "regulator-max-microvolt",
346 						-ENODATA);
347 	uc_pdata->init_uV = dev_read_u32_default(dev, "regulator-init-microvolt",
348 						-ENODATA);
349 	uc_pdata->min_uA = dev_read_u32_default(dev, "regulator-min-microamp",
350 						-ENODATA);
351 	uc_pdata->max_uA = dev_read_u32_default(dev, "regulator-max-microamp",
352 						-ENODATA);
353 	uc_pdata->always_on = dev_read_bool(dev, "regulator-always-on");
354 	uc_pdata->boot_on = dev_read_bool(dev, "regulator-boot-on");
355 
356 	node = dev_read_subnode(dev, "regulator-state-mem");
357 	if (ofnode_valid(node)) {
358 		uc_pdata->suspend_on = !ofnode_read_bool(node, "regulator-off-in-suspend");
359 		if (ofnode_read_u32(node, "regulator-suspend-microvolt", &uc_pdata->suspend_uV))
360 			uc_pdata->suspend_uV = uc_pdata->max_uA;
361 	} else {
362 		uc_pdata->suspend_on = true;
363 		uc_pdata->suspend_uV = uc_pdata->max_uA;
364 	}
365 
366 	/* Those values are optional (-ENODATA if unset) */
367 	if ((uc_pdata->min_uV != -ENODATA) &&
368 	    (uc_pdata->max_uV != -ENODATA) &&
369 	    (uc_pdata->min_uV == uc_pdata->max_uV))
370 		uc_pdata->flags |= REGULATOR_FLAG_AUTOSET_UV;
371 
372 	/* Those values are optional (-ENODATA if unset) */
373 	if ((uc_pdata->min_uA != -ENODATA) &&
374 	    (uc_pdata->max_uA != -ENODATA) &&
375 	    (uc_pdata->min_uA == uc_pdata->max_uA))
376 		uc_pdata->flags |= REGULATOR_FLAG_AUTOSET_UA;
377 
378 	debug("dev.name=%s: min_uV=%d, max_uV=%d, boot-on=%d, always-on=%d, "
379 	      "off-in-suspend=%d, suspend_volt=%d\n",
380 	      dev->name, uc_pdata->min_uV, uc_pdata->max_uV, uc_pdata->boot_on,
381 	      uc_pdata->always_on, !uc_pdata->suspend_on, uc_pdata->suspend_uV);
382 
383 	return 0;
384 }
385 
386 int regulators_enable_boot_on(bool verbose)
387 {
388 	struct udevice *dev;
389 	struct uclass *uc;
390 	int ret;
391 
392 	ret = uclass_get(UCLASS_REGULATOR, &uc);
393 	if (ret)
394 		return ret;
395 	for (uclass_first_device(UCLASS_REGULATOR, &dev);
396 	     dev;
397 	     uclass_next_device(&dev)) {
398 		ret = regulator_autoset(dev);
399 		if (ret == -EMEDIUMTYPE) {
400 			ret = 0;
401 			continue;
402 		}
403 		if (verbose)
404 			regulator_show(dev, ret);
405 		if (ret == -ENOSYS)
406 			ret = 0;
407 	}
408 
409 	return ret;
410 }
411 
412 UCLASS_DRIVER(regulator) = {
413 	.id		= UCLASS_REGULATOR,
414 	.name		= "regulator",
415 	.post_bind	= regulator_post_bind,
416 	.pre_probe	= regulator_pre_probe,
417 	.per_device_platdata_auto_alloc_size =
418 				sizeof(struct dm_regulator_uclass_platdata),
419 };
420