]> git.ipfire.org Git - people/ms/u-boot.git/blame - drivers/core/device.c
mmc: Support bypass mode with the get_mmc_clk() method
[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>
d90a5a30 18#include <dm/pinctrl.h>
6494d708
SG
19#include <dm/platdata.h>
20#include <dm/uclass.h>
21#include <dm/uclass-internal.h>
22#include <dm/util.h>
23#include <linux/err.h>
24#include <linux/list.h>
25
5a66a8ff
SG
26DECLARE_GLOBAL_DATA_PTR;
27
3479253d
SG
28int device_bind(struct udevice *parent, const struct driver *drv,
29 const char *name, void *platdata, int of_offset,
30 struct udevice **devp)
6494d708 31{
54c5d08a 32 struct udevice *dev;
6494d708 33 struct uclass *uc;
5eaed880 34 int size, ret = 0;
6494d708 35
e6cabe4a
MY
36 if (devp)
37 *devp = NULL;
6494d708
SG
38 if (!name)
39 return -EINVAL;
40
41 ret = uclass_get(drv->id, &uc);
42 if (ret)
43 return ret;
44
54c5d08a 45 dev = calloc(1, sizeof(struct udevice));
6494d708
SG
46 if (!dev)
47 return -ENOMEM;
48
49 INIT_LIST_HEAD(&dev->sibling_node);
50 INIT_LIST_HEAD(&dev->child_head);
51 INIT_LIST_HEAD(&dev->uclass_node);
e2282d70 52#ifdef CONFIG_DEVRES
608f26c5 53 INIT_LIST_HEAD(&dev->devres_head);
e2282d70 54#endif
6494d708
SG
55 dev->platdata = platdata;
56 dev->name = name;
57 dev->of_offset = of_offset;
58 dev->parent = parent;
59 dev->driver = drv;
60 dev->uclass = uc;
5a66a8ff 61
5a66a8ff 62 dev->seq = -1;
9cc36a2b 63 dev->req_seq = -1;
0f925822 64 if (CONFIG_IS_ENABLED(OF_CONTROL) && IS_ENABLED(CONFIG_DM_SEQ_ALIAS)) {
36fa61dc
SG
65 /*
66 * Some devices, such as a SPI bus, I2C bus and serial ports
67 * are numbered using aliases.
68 *
69 * This is just a 'requested' sequence, and will be
70 * resolved (and ->seq updated) when the device is probed.
71 */
72 if (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS) {
73 if (uc->uc_drv->name && of_offset != -1) {
74 fdtdec_get_alias_seq(gd->fdt_blob,
75 uc->uc_drv->name, of_offset,
76 &dev->req_seq);
77 }
9cc36a2b 78 }
5a66a8ff 79 }
36fa61dc 80
f8a85449 81 if (!dev->platdata && drv->platdata_auto_alloc_size) {
6494d708 82 dev->flags |= DM_FLAG_ALLOC_PDATA;
f8a85449
SG
83 dev->platdata = calloc(1, drv->platdata_auto_alloc_size);
84 if (!dev->platdata) {
85 ret = -ENOMEM;
86 goto fail_alloc1;
87 }
88 }
cdc133bd 89
5eaed880
PM
90 size = uc->uc_drv->per_device_platdata_auto_alloc_size;
91 if (size) {
92 dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
93 dev->uclass_platdata = calloc(1, size);
94 if (!dev->uclass_platdata) {
95 ret = -ENOMEM;
96 goto fail_alloc2;
97 }
98 }
99
100 if (parent) {
101 size = parent->driver->per_child_platdata_auto_alloc_size;
ba8da9dc
SG
102 if (!size) {
103 size = parent->uclass->uc_drv->
104 per_child_platdata_auto_alloc_size;
105 }
cdc133bd
SG
106 if (size) {
107 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
108 dev->parent_platdata = calloc(1, size);
109 if (!dev->parent_platdata) {
110 ret = -ENOMEM;
5eaed880 111 goto fail_alloc3;
cdc133bd
SG
112 }
113 }
114 }
6494d708
SG
115
116 /* put dev into parent's successor list */
117 if (parent)
118 list_add_tail(&dev->sibling_node, &parent->child_head);
119
120 ret = uclass_bind_device(dev);
121 if (ret)
72ebfe86 122 goto fail_uclass_bind;
6494d708
SG
123
124 /* if we fail to bind we remove device from successors and free it */
125 if (drv->bind) {
126 ret = drv->bind(dev);
72ebfe86 127 if (ret)
6494d708 128 goto fail_bind;
6494d708 129 }
0118ce79
SG
130 if (parent && parent->driver->child_post_bind) {
131 ret = parent->driver->child_post_bind(dev);
132 if (ret)
133 goto fail_child_post_bind;
134 }
135
6494d708
SG
136 if (parent)
137 dm_dbg("Bound device %s to %s\n", dev->name, parent->name);
e6cabe4a
MY
138 if (devp)
139 *devp = dev;
6494d708 140
aed1a4dd
MY
141 dev->flags |= DM_FLAG_BOUND;
142
6494d708
SG
143 return 0;
144
0118ce79 145fail_child_post_bind:
0a5804b5 146 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
5a87c417
SG
147 if (drv->unbind && drv->unbind(dev)) {
148 dm_warn("unbind() method failed on dev '%s' on error path\n",
149 dev->name);
150 }
0118ce79
SG
151 }
152
6494d708 153fail_bind:
0a5804b5 154 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
5a87c417
SG
155 if (uclass_unbind_device(dev)) {
156 dm_warn("Failed to unbind dev '%s' on error path\n",
157 dev->name);
158 }
72ebfe86
SG
159 }
160fail_uclass_bind:
0a5804b5 161 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
5a87c417
SG
162 list_del(&dev->sibling_node);
163 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
164 free(dev->parent_platdata);
165 dev->parent_platdata = NULL;
166 }
cdc133bd 167 }
5eaed880
PM
168fail_alloc3:
169 if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
170 free(dev->uclass_platdata);
171 dev->uclass_platdata = NULL;
172 }
cdc133bd 173fail_alloc2:
f8a85449
SG
174 if (dev->flags & DM_FLAG_ALLOC_PDATA) {
175 free(dev->platdata);
176 dev->platdata = NULL;
177 }
178fail_alloc1:
608f26c5
MY
179 devres_release_all(dev);
180
6494d708 181 free(dev);
72ebfe86 182
6494d708
SG
183 return ret;
184}
185
00606d7e
SG
186int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
187 const struct driver_info *info, struct udevice **devp)
6494d708
SG
188{
189 struct driver *drv;
190
191 drv = lists_driver_lookup_name(info->name);
192 if (!drv)
193 return -ENOENT;
00606d7e
SG
194 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
195 return -EPERM;
6494d708
SG
196
197 return device_bind(parent, drv, info->name, (void *)info->platdata,
198 -1, devp);
199}
200
2c03c463
SG
201static void *alloc_priv(int size, uint flags)
202{
203 void *priv;
204
205 if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
206 priv = memalign(ARCH_DMA_MINALIGN, size);
207 if (priv)
208 memset(priv, '\0', size);
209 } else {
210 priv = calloc(1, size);
211 }
212
213 return priv;
214}
215
accd4b19 216int device_probe_child(struct udevice *dev, void *parent_priv)
6494d708 217{
3479253d 218 const struct driver *drv;
6494d708
SG
219 int size = 0;
220 int ret;
5a66a8ff 221 int seq;
6494d708
SG
222
223 if (!dev)
224 return -EINVAL;
225
226 if (dev->flags & DM_FLAG_ACTIVATED)
227 return 0;
228
229 drv = dev->driver;
230 assert(drv);
231
cdeb2ba9
BM
232 /* Allocate private data if requested and not reentered */
233 if (drv->priv_auto_alloc_size && !dev->priv) {
2c03c463 234 dev->priv = alloc_priv(drv->priv_auto_alloc_size, drv->flags);
6494d708
SG
235 if (!dev->priv) {
236 ret = -ENOMEM;
237 goto fail;
238 }
239 }
cdeb2ba9 240 /* Allocate private data if requested and not reentered */
6494d708 241 size = dev->uclass->uc_drv->per_device_auto_alloc_size;
cdeb2ba9 242 if (size && !dev->uclass_priv) {
6494d708
SG
243 dev->uclass_priv = calloc(1, size);
244 if (!dev->uclass_priv) {
245 ret = -ENOMEM;
246 goto fail;
247 }
248 }
249
250 /* Ensure all parents are probed */
251 if (dev->parent) {
e59f458d 252 size = dev->parent->driver->per_child_auto_alloc_size;
dac8db2c
SG
253 if (!size) {
254 size = dev->parent->uclass->uc_drv->
255 per_child_auto_alloc_size;
256 }
cdeb2ba9 257 if (size && !dev->parent_priv) {
2c03c463 258 dev->parent_priv = alloc_priv(size, drv->flags);
e59f458d
SG
259 if (!dev->parent_priv) {
260 ret = -ENOMEM;
261 goto fail;
262 }
accd4b19
SG
263 if (parent_priv)
264 memcpy(dev->parent_priv, parent_priv, size);
e59f458d
SG
265 }
266
6494d708
SG
267 ret = device_probe(dev->parent);
268 if (ret)
269 goto fail;
cdeb2ba9
BM
270
271 /*
272 * The device might have already been probed during
273 * the call to device_probe() on its parent device
274 * (e.g. PCI bridge devices). Test the flags again
275 * so that we don't mess up the device.
276 */
277 if (dev->flags & DM_FLAG_ACTIVATED)
278 return 0;
6494d708
SG
279 }
280
5a66a8ff
SG
281 seq = uclass_resolve_seq(dev);
282 if (seq < 0) {
283 ret = seq;
284 goto fail;
285 }
286 dev->seq = seq;
287
206d4d2b
SG
288 dev->flags |= DM_FLAG_ACTIVATED;
289
d90a5a30
MY
290 /* continue regardless of the result of pinctrl */
291 pinctrl_select_state(dev, "default");
292
02c07b37 293 ret = uclass_pre_probe_device(dev);
83c7e434
SG
294 if (ret)
295 goto fail;
296
a327dee0
SG
297 if (dev->parent && dev->parent->driver->child_pre_probe) {
298 ret = dev->parent->driver->child_pre_probe(dev);
299 if (ret)
300 goto fail;
301 }
302
6494d708
SG
303 if (drv->ofdata_to_platdata && dev->of_offset >= 0) {
304 ret = drv->ofdata_to_platdata(dev);
305 if (ret)
306 goto fail;
307 }
308
309 if (drv->probe) {
310 ret = drv->probe(dev);
02eeb1bb
SG
311 if (ret) {
312 dev->flags &= ~DM_FLAG_ACTIVATED;
6494d708 313 goto fail;
02eeb1bb 314 }
6494d708
SG
315 }
316
6494d708 317 ret = uclass_post_probe_device(dev);
206d4d2b 318 if (ret)
6494d708 319 goto fail_uclass;
6494d708
SG
320
321 return 0;
322fail_uclass:
323 if (device_remove(dev)) {
324 dm_warn("%s: Device '%s' failed to remove on error path\n",
325 __func__, dev->name);
326 }
327fail:
206d4d2b
SG
328 dev->flags &= ~DM_FLAG_ACTIVATED;
329
5a66a8ff 330 dev->seq = -1;
6494d708
SG
331 device_free(dev);
332
333 return ret;
334}
335
accd4b19
SG
336int device_probe(struct udevice *dev)
337{
338 return device_probe_child(dev, NULL);
339}
340
54c5d08a 341void *dev_get_platdata(struct udevice *dev)
6494d708
SG
342{
343 if (!dev) {
964d153c 344 dm_warn("%s: null device\n", __func__);
6494d708
SG
345 return NULL;
346 }
347
348 return dev->platdata;
349}
350
cdc133bd
SG
351void *dev_get_parent_platdata(struct udevice *dev)
352{
353 if (!dev) {
36d7cc17 354 dm_warn("%s: null device\n", __func__);
cdc133bd
SG
355 return NULL;
356 }
357
358 return dev->parent_platdata;
359}
360
5eaed880
PM
361void *dev_get_uclass_platdata(struct udevice *dev)
362{
363 if (!dev) {
36d7cc17 364 dm_warn("%s: null device\n", __func__);
5eaed880
PM
365 return NULL;
366 }
367
368 return dev->uclass_platdata;
369}
370
54c5d08a 371void *dev_get_priv(struct udevice *dev)
6494d708
SG
372{
373 if (!dev) {
964d153c 374 dm_warn("%s: null device\n", __func__);
6494d708
SG
375 return NULL;
376 }
377
378 return dev->priv;
379}
997c87bb 380
e564f054
SG
381void *dev_get_uclass_priv(struct udevice *dev)
382{
383 if (!dev) {
384 dm_warn("%s: null device\n", __func__);
385 return NULL;
386 }
387
388 return dev->uclass_priv;
389}
390
e59f458d
SG
391void *dev_get_parentdata(struct udevice *dev)
392{
393 if (!dev) {
964d153c 394 dm_warn("%s: null device\n", __func__);
e59f458d
SG
395 return NULL;
396 }
397
398 return dev->parent_priv;
399}
400
997c87bb
SG
401static int device_get_device_tail(struct udevice *dev, int ret,
402 struct udevice **devp)
403{
404 if (ret)
405 return ret;
406
407 ret = device_probe(dev);
408 if (ret)
409 return ret;
410
411 *devp = dev;
412
413 return 0;
414}
415
416int device_get_child(struct udevice *parent, int index, struct udevice **devp)
417{
418 struct udevice *dev;
419
420 list_for_each_entry(dev, &parent->child_head, sibling_node) {
421 if (!index--)
422 return device_get_device_tail(dev, 0, devp);
423 }
424
425 return -ENODEV;
426}
427
428int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
429 bool find_req_seq, struct udevice **devp)
430{
431 struct udevice *dev;
432
433 *devp = NULL;
434 if (seq_or_req_seq == -1)
435 return -ENODEV;
436
437 list_for_each_entry(dev, &parent->child_head, sibling_node) {
438 if ((find_req_seq ? dev->req_seq : dev->seq) ==
439 seq_or_req_seq) {
440 *devp = dev;
441 return 0;
442 }
443 }
444
445 return -ENODEV;
446}
447
448int device_get_child_by_seq(struct udevice *parent, int seq,
449 struct udevice **devp)
450{
451 struct udevice *dev;
452 int ret;
453
454 *devp = NULL;
455 ret = device_find_child_by_seq(parent, seq, false, &dev);
456 if (ret == -ENODEV) {
457 /*
458 * We didn't find it in probed devices. See if there is one
459 * that will request this seq if probed.
460 */
461 ret = device_find_child_by_seq(parent, seq, true, &dev);
462 }
463 return device_get_device_tail(dev, ret, devp);
464}
465
466int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
467 struct udevice **devp)
468{
469 struct udevice *dev;
470
471 *devp = NULL;
472
473 list_for_each_entry(dev, &parent->child_head, sibling_node) {
474 if (dev->of_offset == of_offset) {
475 *devp = dev;
476 return 0;
477 }
478 }
479
480 return -ENODEV;
481}
482
132f9bfc 483int device_get_child_by_of_offset(struct udevice *parent, int node,
997c87bb
SG
484 struct udevice **devp)
485{
486 struct udevice *dev;
487 int ret;
488
489 *devp = NULL;
132f9bfc 490 ret = device_find_child_by_of_offset(parent, node, &dev);
997c87bb
SG
491 return device_get_device_tail(dev, ret, devp);
492}
a8981d4f 493
2693047a
SG
494static struct udevice *_device_find_global_by_of_offset(struct udevice *parent,
495 int of_offset)
496{
497 struct udevice *dev, *found;
498
499 if (parent->of_offset == of_offset)
500 return parent;
501
502 list_for_each_entry(dev, &parent->child_head, sibling_node) {
503 found = _device_find_global_by_of_offset(dev, of_offset);
504 if (found)
505 return found;
506 }
507
508 return NULL;
509}
510
511int device_get_global_by_of_offset(int of_offset, struct udevice **devp)
512{
513 struct udevice *dev;
514
515 dev = _device_find_global_by_of_offset(gd->dm_root, of_offset);
516 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
517}
518
a8981d4f
SG
519int device_find_first_child(struct udevice *parent, struct udevice **devp)
520{
521 if (list_empty(&parent->child_head)) {
522 *devp = NULL;
523 } else {
524 *devp = list_first_entry(&parent->child_head, struct udevice,
525 sibling_node);
526 }
527
528 return 0;
529}
530
531int device_find_next_child(struct udevice **devp)
532{
533 struct udevice *dev = *devp;
534 struct udevice *parent = dev->parent;
535
536 if (list_is_last(&dev->sibling_node, &parent->child_head)) {
537 *devp = NULL;
538 } else {
539 *devp = list_entry(dev->sibling_node.next, struct udevice,
540 sibling_node);
541 }
542
543 return 0;
544}
2ef249b4 545
479728cb
SG
546struct udevice *dev_get_parent(struct udevice *child)
547{
548 return child->parent;
549}
550
39de8433 551ulong dev_get_driver_data(struct udevice *dev)
2ef249b4 552{
39de8433 553 return dev->driver_data;
2ef249b4 554}
b3670531 555
cc73d37b
PM
556const void *dev_get_driver_ops(struct udevice *dev)
557{
558 if (!dev || !dev->driver->ops)
559 return NULL;
560
561 return dev->driver->ops;
562}
563
b3670531
SG
564enum uclass_id device_get_uclass_id(struct udevice *dev)
565{
566 return dev->uclass->uc_drv->id;
567}
c9cac3f8 568
f9c370dc
PM
569const char *dev_get_uclass_name(struct udevice *dev)
570{
571 if (!dev)
572 return NULL;
573
574 return dev->uclass->uc_drv->name;
575}
576
c9cac3f8
PF
577fdt_addr_t dev_get_addr(struct udevice *dev)
578{
0f925822 579#if CONFIG_IS_ENABLED(OF_CONTROL)
f3301771
SG
580 fdt_addr_t addr;
581
582 addr = fdtdec_get_addr(gd->fdt_blob, dev->of_offset, "reg");
628d792c 583 if (CONFIG_IS_ENABLED(SIMPLE_BUS) && addr != FDT_ADDR_T_NONE) {
f3301771
SG
584 if (device_get_uclass_id(dev->parent) == UCLASS_SIMPLE_BUS)
585 addr = simple_bus_translate(dev->parent, addr);
586 }
587
588 return addr;
c9cac3f8 589#else
c9cac3f8 590 return FDT_ADDR_T_NONE;
c9cac3f8 591#endif
f3301771 592}
c5785673
SG
593
594bool device_has_children(struct udevice *dev)
595{
596 return !list_empty(&dev->child_head);
597}
598
599bool device_has_active_children(struct udevice *dev)
600{
601 struct udevice *child;
602
603 for (device_find_first_child(dev, &child);
604 child;
605 device_find_next_child(&child)) {
606 if (device_active(child))
607 return true;
608 }
609
610 return false;
611}
612
613bool device_is_last_sibling(struct udevice *dev)
614{
615 struct udevice *parent = dev->parent;
616
617 if (!parent)
618 return false;
619 return list_is_last(&dev->sibling_node, &parent->child_head);
620}
f5c67ea0
SG
621
622int device_set_name(struct udevice *dev, const char *name)
623{
624 name = strdup(name);
625 if (!name)
626 return -ENOMEM;
627 dev->name = name;
628
629 return 0;
630}