]> git.ipfire.org Git - people/ms/u-boot.git/blame - drivers/core/device.c
dm: core: Add a flag to control sequence numbering
[people/ms/u-boot.git] / drivers / core / device.c
CommitLineData
6494d708
SG
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>
5a66a8ff 13#include <fdtdec.h>
6494d708
SG
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
5a66a8ff
SG
25DECLARE_GLOBAL_DATA_PTR;
26
54c5d08a
HS
27int device_bind(struct udevice *parent, struct driver *drv, const char *name,
28 void *platdata, int of_offset, struct udevice **devp)
6494d708 29{
54c5d08a 30 struct udevice *dev;
6494d708
SG
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
54c5d08a 42 dev = calloc(1, sizeof(struct udevice));
6494d708
SG
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;
5a66a8ff 55
5a66a8ff 56 dev->seq = -1;
9cc36a2b 57 dev->req_seq = -1;
91cbd792 58#ifdef CONFIG_OF_CONTROL
9cc36a2b
SG
59 /*
60 * Some devices, such as a SPI bus, I2C bus and serial ports are
61 * numbered using aliases.
62 *
63 * This is just a 'requested' sequence, and will be
64 * resolved (and ->seq updated) when the device is probed.
65 */
66 if (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS) {
67 if (uc->uc_drv->name && of_offset != -1) {
68 fdtdec_get_alias_seq(gd->fdt_blob, uc->uc_drv->name,
69 of_offset, &dev->req_seq);
70 }
5a66a8ff 71 }
91cbd792 72#endif
f8a85449 73 if (!dev->platdata && drv->platdata_auto_alloc_size) {
6494d708 74 dev->flags |= DM_FLAG_ALLOC_PDATA;
f8a85449
SG
75 dev->platdata = calloc(1, drv->platdata_auto_alloc_size);
76 if (!dev->platdata) {
77 ret = -ENOMEM;
78 goto fail_alloc1;
79 }
80 }
cdc133bd
SG
81 if (parent) {
82 int size = parent->driver->per_child_platdata_auto_alloc_size;
83
ba8da9dc
SG
84 if (!size) {
85 size = parent->uclass->uc_drv->
86 per_child_platdata_auto_alloc_size;
87 }
cdc133bd
SG
88 if (size) {
89 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
90 dev->parent_platdata = calloc(1, size);
91 if (!dev->parent_platdata) {
92 ret = -ENOMEM;
93 goto fail_alloc2;
94 }
95 }
96 }
6494d708
SG
97
98 /* put dev into parent's successor list */
99 if (parent)
100 list_add_tail(&dev->sibling_node, &parent->child_head);
101
102 ret = uclass_bind_device(dev);
103 if (ret)
72ebfe86 104 goto fail_uclass_bind;
6494d708
SG
105
106 /* if we fail to bind we remove device from successors and free it */
107 if (drv->bind) {
108 ret = drv->bind(dev);
72ebfe86 109 if (ret)
6494d708 110 goto fail_bind;
6494d708 111 }
0118ce79
SG
112 if (parent && parent->driver->child_post_bind) {
113 ret = parent->driver->child_post_bind(dev);
114 if (ret)
115 goto fail_child_post_bind;
116 }
117
6494d708
SG
118 if (parent)
119 dm_dbg("Bound device %s to %s\n", dev->name, parent->name);
120 *devp = dev;
121
122 return 0;
123
0118ce79
SG
124fail_child_post_bind:
125 if (drv->unbind && drv->unbind(dev)) {
126 dm_warn("unbind() method failed on dev '%s' on error path\n",
127 dev->name);
128 }
129
6494d708 130fail_bind:
72ebfe86
SG
131 if (uclass_unbind_device(dev)) {
132 dm_warn("Failed to unbind dev '%s' on error path\n",
133 dev->name);
134 }
135fail_uclass_bind:
cdc133bd
SG
136 list_del(&dev->sibling_node);
137 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
138 free(dev->parent_platdata);
139 dev->parent_platdata = NULL;
140 }
141fail_alloc2:
f8a85449
SG
142 if (dev->flags & DM_FLAG_ALLOC_PDATA) {
143 free(dev->platdata);
144 dev->platdata = NULL;
145 }
146fail_alloc1:
6494d708 147 free(dev);
72ebfe86 148
6494d708
SG
149 return ret;
150}
151
00606d7e
SG
152int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
153 const struct driver_info *info, struct udevice **devp)
6494d708
SG
154{
155 struct driver *drv;
156
157 drv = lists_driver_lookup_name(info->name);
158 if (!drv)
159 return -ENOENT;
00606d7e
SG
160 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
161 return -EPERM;
6494d708
SG
162
163 return device_bind(parent, drv, info->name, (void *)info->platdata,
164 -1, devp);
165}
166
accd4b19 167int device_probe_child(struct udevice *dev, void *parent_priv)
6494d708
SG
168{
169 struct driver *drv;
170 int size = 0;
171 int ret;
5a66a8ff 172 int seq;
6494d708
SG
173
174 if (!dev)
175 return -EINVAL;
176
177 if (dev->flags & DM_FLAG_ACTIVATED)
178 return 0;
179
180 drv = dev->driver;
181 assert(drv);
182
f8a85449 183 /* Allocate private data if requested */
6494d708
SG
184 if (drv->priv_auto_alloc_size) {
185 dev->priv = calloc(1, drv->priv_auto_alloc_size);
186 if (!dev->priv) {
187 ret = -ENOMEM;
188 goto fail;
189 }
190 }
191 /* Allocate private data if requested */
6494d708
SG
192 size = dev->uclass->uc_drv->per_device_auto_alloc_size;
193 if (size) {
194 dev->uclass_priv = calloc(1, size);
195 if (!dev->uclass_priv) {
196 ret = -ENOMEM;
197 goto fail;
198 }
199 }
200
201 /* Ensure all parents are probed */
202 if (dev->parent) {
e59f458d
SG
203 size = dev->parent->driver->per_child_auto_alloc_size;
204 if (size) {
205 dev->parent_priv = calloc(1, size);
206 if (!dev->parent_priv) {
207 ret = -ENOMEM;
208 goto fail;
209 }
accd4b19
SG
210 if (parent_priv)
211 memcpy(dev->parent_priv, parent_priv, size);
e59f458d
SG
212 }
213
6494d708
SG
214 ret = device_probe(dev->parent);
215 if (ret)
216 goto fail;
217 }
218
5a66a8ff
SG
219 seq = uclass_resolve_seq(dev);
220 if (seq < 0) {
221 ret = seq;
222 goto fail;
223 }
224 dev->seq = seq;
225
a327dee0
SG
226 if (dev->parent && dev->parent->driver->child_pre_probe) {
227 ret = dev->parent->driver->child_pre_probe(dev);
228 if (ret)
229 goto fail;
230 }
231
6494d708
SG
232 if (drv->ofdata_to_platdata && dev->of_offset >= 0) {
233 ret = drv->ofdata_to_platdata(dev);
234 if (ret)
235 goto fail;
236 }
237
238 if (drv->probe) {
239 ret = drv->probe(dev);
240 if (ret)
241 goto fail;
242 }
243
244 dev->flags |= DM_FLAG_ACTIVATED;
245
246 ret = uclass_post_probe_device(dev);
247 if (ret) {
248 dev->flags &= ~DM_FLAG_ACTIVATED;
249 goto fail_uclass;
250 }
251
252 return 0;
253fail_uclass:
254 if (device_remove(dev)) {
255 dm_warn("%s: Device '%s' failed to remove on error path\n",
256 __func__, dev->name);
257 }
258fail:
5a66a8ff 259 dev->seq = -1;
6494d708
SG
260 device_free(dev);
261
262 return ret;
263}
264
accd4b19
SG
265int device_probe(struct udevice *dev)
266{
267 return device_probe_child(dev, NULL);
268}
269
54c5d08a 270void *dev_get_platdata(struct udevice *dev)
6494d708
SG
271{
272 if (!dev) {
964d153c 273 dm_warn("%s: null device\n", __func__);
6494d708
SG
274 return NULL;
275 }
276
277 return dev->platdata;
278}
279
cdc133bd
SG
280void *dev_get_parent_platdata(struct udevice *dev)
281{
282 if (!dev) {
283 dm_warn("%s: null device", __func__);
284 return NULL;
285 }
286
287 return dev->parent_platdata;
288}
289
54c5d08a 290void *dev_get_priv(struct udevice *dev)
6494d708
SG
291{
292 if (!dev) {
964d153c 293 dm_warn("%s: null device\n", __func__);
6494d708
SG
294 return NULL;
295 }
296
297 return dev->priv;
298}
997c87bb 299
e59f458d
SG
300void *dev_get_parentdata(struct udevice *dev)
301{
302 if (!dev) {
964d153c 303 dm_warn("%s: null device\n", __func__);
e59f458d
SG
304 return NULL;
305 }
306
307 return dev->parent_priv;
308}
309
997c87bb
SG
310static int device_get_device_tail(struct udevice *dev, int ret,
311 struct udevice **devp)
312{
313 if (ret)
314 return ret;
315
316 ret = device_probe(dev);
317 if (ret)
318 return ret;
319
320 *devp = dev;
321
322 return 0;
323}
324
325int device_get_child(struct udevice *parent, int index, struct udevice **devp)
326{
327 struct udevice *dev;
328
329 list_for_each_entry(dev, &parent->child_head, sibling_node) {
330 if (!index--)
331 return device_get_device_tail(dev, 0, devp);
332 }
333
334 return -ENODEV;
335}
336
337int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
338 bool find_req_seq, struct udevice **devp)
339{
340 struct udevice *dev;
341
342 *devp = NULL;
343 if (seq_or_req_seq == -1)
344 return -ENODEV;
345
346 list_for_each_entry(dev, &parent->child_head, sibling_node) {
347 if ((find_req_seq ? dev->req_seq : dev->seq) ==
348 seq_or_req_seq) {
349 *devp = dev;
350 return 0;
351 }
352 }
353
354 return -ENODEV;
355}
356
357int device_get_child_by_seq(struct udevice *parent, int seq,
358 struct udevice **devp)
359{
360 struct udevice *dev;
361 int ret;
362
363 *devp = NULL;
364 ret = device_find_child_by_seq(parent, seq, false, &dev);
365 if (ret == -ENODEV) {
366 /*
367 * We didn't find it in probed devices. See if there is one
368 * that will request this seq if probed.
369 */
370 ret = device_find_child_by_seq(parent, seq, true, &dev);
371 }
372 return device_get_device_tail(dev, ret, devp);
373}
374
375int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
376 struct udevice **devp)
377{
378 struct udevice *dev;
379
380 *devp = NULL;
381
382 list_for_each_entry(dev, &parent->child_head, sibling_node) {
383 if (dev->of_offset == of_offset) {
384 *devp = dev;
385 return 0;
386 }
387 }
388
389 return -ENODEV;
390}
391
392int device_get_child_by_of_offset(struct udevice *parent, int seq,
393 struct udevice **devp)
394{
395 struct udevice *dev;
396 int ret;
397
398 *devp = NULL;
399 ret = device_find_child_by_of_offset(parent, seq, &dev);
400 return device_get_device_tail(dev, ret, devp);
401}
a8981d4f
SG
402
403int device_find_first_child(struct udevice *parent, struct udevice **devp)
404{
405 if (list_empty(&parent->child_head)) {
406 *devp = NULL;
407 } else {
408 *devp = list_first_entry(&parent->child_head, struct udevice,
409 sibling_node);
410 }
411
412 return 0;
413}
414
415int device_find_next_child(struct udevice **devp)
416{
417 struct udevice *dev = *devp;
418 struct udevice *parent = dev->parent;
419
420 if (list_is_last(&dev->sibling_node, &parent->child_head)) {
421 *devp = NULL;
422 } else {
423 *devp = list_entry(dev->sibling_node.next, struct udevice,
424 sibling_node);
425 }
426
427 return 0;
428}
2ef249b4 429
479728cb
SG
430struct udevice *dev_get_parent(struct udevice *child)
431{
432 return child->parent;
433}
434
2ef249b4
SG
435ulong dev_get_of_data(struct udevice *dev)
436{
437 return dev->of_id->data;
438}
b3670531
SG
439
440enum uclass_id device_get_uclass_id(struct udevice *dev)
441{
442 return dev->uclass->uc_drv->id;
443}