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