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