xref: /rk3399_rockchip-uboot/drivers/core/device.c (revision 72ebfe86fac2ca0a0e1af9fe1eaa3a634e3e17a1)
1 /*
2  * Device manager
3  *
4  * Copyright (c) 2013 Google, Inc
5  *
6  * (C) Copyright 2012
7  * Pavel Herrmann <morpheus.ibis@gmail.com>
8  *
9  * SPDX-License-Identifier:	GPL-2.0+
10  */
11 
12 #include <common.h>
13 #include <fdtdec.h>
14 #include <malloc.h>
15 #include <dm/device.h>
16 #include <dm/device-internal.h>
17 #include <dm/lists.h>
18 #include <dm/platdata.h>
19 #include <dm/uclass.h>
20 #include <dm/uclass-internal.h>
21 #include <dm/util.h>
22 #include <linux/err.h>
23 #include <linux/list.h>
24 
25 DECLARE_GLOBAL_DATA_PTR;
26 
27 int device_bind(struct udevice *parent, struct driver *drv, const char *name,
28 		void *platdata, int of_offset, struct udevice **devp)
29 {
30 	struct udevice *dev;
31 	struct uclass *uc;
32 	int ret = 0;
33 
34 	*devp = NULL;
35 	if (!name)
36 		return -EINVAL;
37 
38 	ret = uclass_get(drv->id, &uc);
39 	if (ret)
40 		return ret;
41 
42 	dev = calloc(1, sizeof(struct udevice));
43 	if (!dev)
44 		return -ENOMEM;
45 
46 	INIT_LIST_HEAD(&dev->sibling_node);
47 	INIT_LIST_HEAD(&dev->child_head);
48 	INIT_LIST_HEAD(&dev->uclass_node);
49 	dev->platdata = platdata;
50 	dev->name = name;
51 	dev->of_offset = of_offset;
52 	dev->parent = parent;
53 	dev->driver = drv;
54 	dev->uclass = uc;
55 
56 	/*
57 	 * For some devices, such as a SPI or I2C bus, the 'reg' property
58 	 * is a reasonable indicator of the sequence number. But if there is
59 	 * an alias, we use that in preference. In any case, this is just
60 	 * a 'requested' sequence, and will be resolved (and ->seq updated)
61 	 * when the device is probed.
62 	 */
63 	dev->seq = -1;
64 #ifdef CONFIG_OF_CONTROL
65 	dev->req_seq = fdtdec_get_int(gd->fdt_blob, of_offset, "reg", -1);
66 	if (!IS_ERR_VALUE(dev->req_seq))
67 		dev->req_seq &= INT_MAX;
68 	if (uc->uc_drv->name && of_offset != -1) {
69 		fdtdec_get_alias_seq(gd->fdt_blob, uc->uc_drv->name, of_offset,
70 				     &dev->req_seq);
71 	}
72 #else
73 	dev->req_seq = -1;
74 #endif
75 	if (!dev->platdata && drv->platdata_auto_alloc_size)
76 		dev->flags |= DM_FLAG_ALLOC_PDATA;
77 
78 	/* put dev into parent's successor list */
79 	if (parent)
80 		list_add_tail(&dev->sibling_node, &parent->child_head);
81 
82 	ret = uclass_bind_device(dev);
83 	if (ret)
84 		goto fail_uclass_bind;
85 
86 	/* if we fail to bind we remove device from successors and free it */
87 	if (drv->bind) {
88 		ret = drv->bind(dev);
89 		if (ret)
90 			goto fail_bind;
91 	}
92 	if (parent)
93 		dm_dbg("Bound device %s to %s\n", dev->name, parent->name);
94 	*devp = dev;
95 
96 	return 0;
97 
98 fail_bind:
99 	if (uclass_unbind_device(dev)) {
100 		dm_warn("Failed to unbind dev '%s' on error path\n",
101 			dev->name);
102 	}
103 fail_uclass_bind:
104 	if (parent)
105 		list_del(&dev->sibling_node);
106 	free(dev);
107 
108 	return ret;
109 }
110 
111 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
112 			const struct driver_info *info, struct udevice **devp)
113 {
114 	struct driver *drv;
115 
116 	drv = lists_driver_lookup_name(info->name);
117 	if (!drv)
118 		return -ENOENT;
119 	if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
120 		return -EPERM;
121 
122 	return device_bind(parent, drv, info->name, (void *)info->platdata,
123 			   -1, devp);
124 }
125 
126 int device_probe_child(struct udevice *dev, void *parent_priv)
127 {
128 	struct driver *drv;
129 	int size = 0;
130 	int ret;
131 	int seq;
132 
133 	if (!dev)
134 		return -EINVAL;
135 
136 	if (dev->flags & DM_FLAG_ACTIVATED)
137 		return 0;
138 
139 	drv = dev->driver;
140 	assert(drv);
141 
142 	/* Allocate private data and platdata if requested */
143 	if (drv->priv_auto_alloc_size) {
144 		dev->priv = calloc(1, drv->priv_auto_alloc_size);
145 		if (!dev->priv) {
146 			ret = -ENOMEM;
147 			goto fail;
148 		}
149 	}
150 	/* Allocate private data if requested */
151 	if (dev->flags & DM_FLAG_ALLOC_PDATA) {
152 		dev->platdata = calloc(1, drv->platdata_auto_alloc_size);
153 		if (!dev->platdata) {
154 			ret = -ENOMEM;
155 			goto fail;
156 		}
157 	}
158 	size = dev->uclass->uc_drv->per_device_auto_alloc_size;
159 	if (size) {
160 		dev->uclass_priv = calloc(1, size);
161 		if (!dev->uclass_priv) {
162 			ret = -ENOMEM;
163 			goto fail;
164 		}
165 	}
166 
167 	/* Ensure all parents are probed */
168 	if (dev->parent) {
169 		size = dev->parent->driver->per_child_auto_alloc_size;
170 		if (size) {
171 			dev->parent_priv = calloc(1, size);
172 			if (!dev->parent_priv) {
173 				ret = -ENOMEM;
174 				goto fail;
175 			}
176 			if (parent_priv)
177 				memcpy(dev->parent_priv, parent_priv, size);
178 		}
179 
180 		ret = device_probe(dev->parent);
181 		if (ret)
182 			goto fail;
183 	}
184 
185 	seq = uclass_resolve_seq(dev);
186 	if (seq < 0) {
187 		ret = seq;
188 		goto fail;
189 	}
190 	dev->seq = seq;
191 
192 	if (dev->parent && dev->parent->driver->child_pre_probe) {
193 		ret = dev->parent->driver->child_pre_probe(dev);
194 		if (ret)
195 			goto fail;
196 	}
197 
198 	if (drv->ofdata_to_platdata && dev->of_offset >= 0) {
199 		ret = drv->ofdata_to_platdata(dev);
200 		if (ret)
201 			goto fail;
202 	}
203 
204 	if (drv->probe) {
205 		ret = drv->probe(dev);
206 		if (ret)
207 			goto fail;
208 	}
209 
210 	dev->flags |= DM_FLAG_ACTIVATED;
211 
212 	ret = uclass_post_probe_device(dev);
213 	if (ret) {
214 		dev->flags &= ~DM_FLAG_ACTIVATED;
215 		goto fail_uclass;
216 	}
217 
218 	return 0;
219 fail_uclass:
220 	if (device_remove(dev)) {
221 		dm_warn("%s: Device '%s' failed to remove on error path\n",
222 			__func__, dev->name);
223 	}
224 fail:
225 	dev->seq = -1;
226 	device_free(dev);
227 
228 	return ret;
229 }
230 
231 int device_probe(struct udevice *dev)
232 {
233 	return device_probe_child(dev, NULL);
234 }
235 
236 void *dev_get_platdata(struct udevice *dev)
237 {
238 	if (!dev) {
239 		dm_warn("%s: null device\n", __func__);
240 		return NULL;
241 	}
242 
243 	return dev->platdata;
244 }
245 
246 void *dev_get_priv(struct udevice *dev)
247 {
248 	if (!dev) {
249 		dm_warn("%s: null device\n", __func__);
250 		return NULL;
251 	}
252 
253 	return dev->priv;
254 }
255 
256 void *dev_get_parentdata(struct udevice *dev)
257 {
258 	if (!dev) {
259 		dm_warn("%s: null device\n", __func__);
260 		return NULL;
261 	}
262 
263 	return dev->parent_priv;
264 }
265 
266 static int device_get_device_tail(struct udevice *dev, int ret,
267 				  struct udevice **devp)
268 {
269 	if (ret)
270 		return ret;
271 
272 	ret = device_probe(dev);
273 	if (ret)
274 		return ret;
275 
276 	*devp = dev;
277 
278 	return 0;
279 }
280 
281 int device_get_child(struct udevice *parent, int index, struct udevice **devp)
282 {
283 	struct udevice *dev;
284 
285 	list_for_each_entry(dev, &parent->child_head, sibling_node) {
286 		if (!index--)
287 			return device_get_device_tail(dev, 0, devp);
288 	}
289 
290 	return -ENODEV;
291 }
292 
293 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
294 			     bool find_req_seq, struct udevice **devp)
295 {
296 	struct udevice *dev;
297 
298 	*devp = NULL;
299 	if (seq_or_req_seq == -1)
300 		return -ENODEV;
301 
302 	list_for_each_entry(dev, &parent->child_head, sibling_node) {
303 		if ((find_req_seq ? dev->req_seq : dev->seq) ==
304 				seq_or_req_seq) {
305 			*devp = dev;
306 			return 0;
307 		}
308 	}
309 
310 	return -ENODEV;
311 }
312 
313 int device_get_child_by_seq(struct udevice *parent, int seq,
314 			    struct udevice **devp)
315 {
316 	struct udevice *dev;
317 	int ret;
318 
319 	*devp = NULL;
320 	ret = device_find_child_by_seq(parent, seq, false, &dev);
321 	if (ret == -ENODEV) {
322 		/*
323 		 * We didn't find it in probed devices. See if there is one
324 		 * that will request this seq if probed.
325 		 */
326 		ret = device_find_child_by_seq(parent, seq, true, &dev);
327 	}
328 	return device_get_device_tail(dev, ret, devp);
329 }
330 
331 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
332 				   struct udevice **devp)
333 {
334 	struct udevice *dev;
335 
336 	*devp = NULL;
337 
338 	list_for_each_entry(dev, &parent->child_head, sibling_node) {
339 		if (dev->of_offset == of_offset) {
340 			*devp = dev;
341 			return 0;
342 		}
343 	}
344 
345 	return -ENODEV;
346 }
347 
348 int device_get_child_by_of_offset(struct udevice *parent, int seq,
349 				  struct udevice **devp)
350 {
351 	struct udevice *dev;
352 	int ret;
353 
354 	*devp = NULL;
355 	ret = device_find_child_by_of_offset(parent, seq, &dev);
356 	return device_get_device_tail(dev, ret, devp);
357 }
358 
359 int device_find_first_child(struct udevice *parent, struct udevice **devp)
360 {
361 	if (list_empty(&parent->child_head)) {
362 		*devp = NULL;
363 	} else {
364 		*devp = list_first_entry(&parent->child_head, struct udevice,
365 					 sibling_node);
366 	}
367 
368 	return 0;
369 }
370 
371 int device_find_next_child(struct udevice **devp)
372 {
373 	struct udevice *dev = *devp;
374 	struct udevice *parent = dev->parent;
375 
376 	if (list_is_last(&dev->sibling_node, &parent->child_head)) {
377 		*devp = NULL;
378 	} else {
379 		*devp = list_entry(dev->sibling_node.next, struct udevice,
380 				   sibling_node);
381 	}
382 
383 	return 0;
384 }
385 
386 struct udevice *dev_get_parent(struct udevice *child)
387 {
388 	return child->parent;
389 }
390 
391 ulong dev_get_of_data(struct udevice *dev)
392 {
393 	return dev->of_id->data;
394 }
395