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