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