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