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