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. Don't process pinctrl 303 * settings for pinctrl devices since the device may not yet be 304 * probed. 305 */ 306 if (dev->parent && device_get_uclass_id(dev) != UCLASS_PINCTRL) 307 pinctrl_select_state(dev, "default"); 308 309 ret = uclass_pre_probe_device(dev); 310 if (ret) 311 goto fail; 312 313 if (dev->parent && dev->parent->driver->child_pre_probe) { 314 ret = dev->parent->driver->child_pre_probe(dev); 315 if (ret) 316 goto fail; 317 } 318 319 if (drv->ofdata_to_platdata && dev->of_offset >= 0) { 320 ret = drv->ofdata_to_platdata(dev); 321 if (ret) 322 goto fail; 323 } 324 325 if (drv->probe) { 326 ret = drv->probe(dev); 327 if (ret) { 328 dev->flags &= ~DM_FLAG_ACTIVATED; 329 goto fail; 330 } 331 } 332 333 ret = uclass_post_probe_device(dev); 334 if (ret) 335 goto fail_uclass; 336 337 return 0; 338 fail_uclass: 339 if (device_remove(dev)) { 340 dm_warn("%s: Device '%s' failed to remove on error path\n", 341 __func__, dev->name); 342 } 343 fail: 344 dev->flags &= ~DM_FLAG_ACTIVATED; 345 346 dev->seq = -1; 347 device_free(dev); 348 349 return ret; 350 } 351 352 int device_probe(struct udevice *dev) 353 { 354 return device_probe_child(dev, NULL); 355 } 356 357 void *dev_get_platdata(struct udevice *dev) 358 { 359 if (!dev) { 360 dm_warn("%s: null device\n", __func__); 361 return NULL; 362 } 363 364 return dev->platdata; 365 } 366 367 void *dev_get_parent_platdata(struct udevice *dev) 368 { 369 if (!dev) { 370 dm_warn("%s: null device\n", __func__); 371 return NULL; 372 } 373 374 return dev->parent_platdata; 375 } 376 377 void *dev_get_uclass_platdata(struct udevice *dev) 378 { 379 if (!dev) { 380 dm_warn("%s: null device\n", __func__); 381 return NULL; 382 } 383 384 return dev->uclass_platdata; 385 } 386 387 void *dev_get_priv(struct udevice *dev) 388 { 389 if (!dev) { 390 dm_warn("%s: null device\n", __func__); 391 return NULL; 392 } 393 394 return dev->priv; 395 } 396 397 void *dev_get_uclass_priv(struct udevice *dev) 398 { 399 if (!dev) { 400 dm_warn("%s: null device\n", __func__); 401 return NULL; 402 } 403 404 return dev->uclass_priv; 405 } 406 407 void *dev_get_parent_priv(struct udevice *dev) 408 { 409 if (!dev) { 410 dm_warn("%s: null device\n", __func__); 411 return NULL; 412 } 413 414 return dev->parent_priv; 415 } 416 417 static int device_get_device_tail(struct udevice *dev, int ret, 418 struct udevice **devp) 419 { 420 if (ret) 421 return ret; 422 423 ret = device_probe(dev); 424 if (ret) 425 return ret; 426 427 *devp = dev; 428 429 return 0; 430 } 431 432 int device_get_child(struct udevice *parent, int index, struct udevice **devp) 433 { 434 struct udevice *dev; 435 436 list_for_each_entry(dev, &parent->child_head, sibling_node) { 437 if (!index--) 438 return device_get_device_tail(dev, 0, devp); 439 } 440 441 return -ENODEV; 442 } 443 444 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq, 445 bool find_req_seq, struct udevice **devp) 446 { 447 struct udevice *dev; 448 449 *devp = NULL; 450 if (seq_or_req_seq == -1) 451 return -ENODEV; 452 453 list_for_each_entry(dev, &parent->child_head, sibling_node) { 454 if ((find_req_seq ? dev->req_seq : dev->seq) == 455 seq_or_req_seq) { 456 *devp = dev; 457 return 0; 458 } 459 } 460 461 return -ENODEV; 462 } 463 464 int device_get_child_by_seq(struct udevice *parent, int seq, 465 struct udevice **devp) 466 { 467 struct udevice *dev; 468 int ret; 469 470 *devp = NULL; 471 ret = device_find_child_by_seq(parent, seq, false, &dev); 472 if (ret == -ENODEV) { 473 /* 474 * We didn't find it in probed devices. See if there is one 475 * that will request this seq if probed. 476 */ 477 ret = device_find_child_by_seq(parent, seq, true, &dev); 478 } 479 return device_get_device_tail(dev, ret, devp); 480 } 481 482 int device_find_child_by_of_offset(struct udevice *parent, int of_offset, 483 struct udevice **devp) 484 { 485 struct udevice *dev; 486 487 *devp = NULL; 488 489 list_for_each_entry(dev, &parent->child_head, sibling_node) { 490 if (dev->of_offset == of_offset) { 491 *devp = dev; 492 return 0; 493 } 494 } 495 496 return -ENODEV; 497 } 498 499 int device_get_child_by_of_offset(struct udevice *parent, int node, 500 struct udevice **devp) 501 { 502 struct udevice *dev; 503 int ret; 504 505 *devp = NULL; 506 ret = device_find_child_by_of_offset(parent, node, &dev); 507 return device_get_device_tail(dev, ret, devp); 508 } 509 510 static struct udevice *_device_find_global_by_of_offset(struct udevice *parent, 511 int of_offset) 512 { 513 struct udevice *dev, *found; 514 515 if (parent->of_offset == of_offset) 516 return parent; 517 518 list_for_each_entry(dev, &parent->child_head, sibling_node) { 519 found = _device_find_global_by_of_offset(dev, of_offset); 520 if (found) 521 return found; 522 } 523 524 return NULL; 525 } 526 527 int device_get_global_by_of_offset(int of_offset, struct udevice **devp) 528 { 529 struct udevice *dev; 530 531 dev = _device_find_global_by_of_offset(gd->dm_root, of_offset); 532 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp); 533 } 534 535 int device_find_first_child(struct udevice *parent, struct udevice **devp) 536 { 537 if (list_empty(&parent->child_head)) { 538 *devp = NULL; 539 } else { 540 *devp = list_first_entry(&parent->child_head, struct udevice, 541 sibling_node); 542 } 543 544 return 0; 545 } 546 547 int device_find_next_child(struct udevice **devp) 548 { 549 struct udevice *dev = *devp; 550 struct udevice *parent = dev->parent; 551 552 if (list_is_last(&dev->sibling_node, &parent->child_head)) { 553 *devp = NULL; 554 } else { 555 *devp = list_entry(dev->sibling_node.next, struct udevice, 556 sibling_node); 557 } 558 559 return 0; 560 } 561 562 struct udevice *dev_get_parent(struct udevice *child) 563 { 564 return child->parent; 565 } 566 567 ulong dev_get_driver_data(struct udevice *dev) 568 { 569 return dev->driver_data; 570 } 571 572 const void *dev_get_driver_ops(struct udevice *dev) 573 { 574 if (!dev || !dev->driver->ops) 575 return NULL; 576 577 return dev->driver->ops; 578 } 579 580 enum uclass_id device_get_uclass_id(struct udevice *dev) 581 { 582 return dev->uclass->uc_drv->id; 583 } 584 585 const char *dev_get_uclass_name(struct udevice *dev) 586 { 587 if (!dev) 588 return NULL; 589 590 return dev->uclass->uc_drv->name; 591 } 592 593 fdt_addr_t dev_get_addr_index(struct udevice *dev, int index) 594 { 595 #if CONFIG_IS_ENABLED(OF_CONTROL) 596 fdt_addr_t addr; 597 598 if (CONFIG_IS_ENABLED(OF_TRANSLATE)) { 599 const fdt32_t *reg; 600 int len = 0; 601 int na, ns; 602 603 na = fdt_address_cells(gd->fdt_blob, dev->parent->of_offset); 604 if (na < 1) { 605 debug("bad #address-cells\n"); 606 return FDT_ADDR_T_NONE; 607 } 608 609 ns = fdt_size_cells(gd->fdt_blob, dev->parent->of_offset); 610 if (ns < 0) { 611 debug("bad #size-cells\n"); 612 return FDT_ADDR_T_NONE; 613 } 614 615 reg = fdt_getprop(gd->fdt_blob, dev->of_offset, "reg", &len); 616 if (!reg || (len <= (index * sizeof(fdt32_t) * (na + ns)))) { 617 debug("Req index out of range\n"); 618 return FDT_ADDR_T_NONE; 619 } 620 621 reg += index * (na + ns); 622 623 /* 624 * Use the full-fledged translate function for complex 625 * bus setups. 626 */ 627 addr = fdt_translate_address((void *)gd->fdt_blob, 628 dev->of_offset, reg); 629 } else { 630 /* 631 * Use the "simple" translate function for less complex 632 * bus setups. 633 */ 634 addr = fdtdec_get_addr_size_auto_parent(gd->fdt_blob, 635 dev->parent->of_offset, 636 dev->of_offset, "reg", 637 index, NULL); 638 if (CONFIG_IS_ENABLED(SIMPLE_BUS) && addr != FDT_ADDR_T_NONE) { 639 if (device_get_uclass_id(dev->parent) == 640 UCLASS_SIMPLE_BUS) 641 addr = simple_bus_translate(dev->parent, addr); 642 } 643 } 644 645 /* 646 * Some platforms need a special address translation. Those 647 * platforms (e.g. mvebu in SPL) can configure a translation 648 * offset in the DM by calling dm_set_translation_offset() that 649 * will get added to all addresses returned by dev_get_addr(). 650 */ 651 addr += dm_get_translation_offset(); 652 653 return addr; 654 #else 655 return FDT_ADDR_T_NONE; 656 #endif 657 } 658 659 fdt_addr_t dev_get_addr(struct udevice *dev) 660 { 661 return dev_get_addr_index(dev, 0); 662 } 663 664 bool device_has_children(struct udevice *dev) 665 { 666 return !list_empty(&dev->child_head); 667 } 668 669 bool device_has_active_children(struct udevice *dev) 670 { 671 struct udevice *child; 672 673 for (device_find_first_child(dev, &child); 674 child; 675 device_find_next_child(&child)) { 676 if (device_active(child)) 677 return true; 678 } 679 680 return false; 681 } 682 683 bool device_is_last_sibling(struct udevice *dev) 684 { 685 struct udevice *parent = dev->parent; 686 687 if (!parent) 688 return false; 689 return list_is_last(&dev->sibling_node, &parent->child_head); 690 } 691 692 int device_set_name(struct udevice *dev, const char *name) 693 { 694 name = strdup(name); 695 if (!name) 696 return -ENOMEM; 697 dev->name = name; 698 699 return 0; 700 } 701