1 /* 2 * Copyright (c) 2013 Google, Inc 3 * 4 * (C) Copyright 2012 5 * Pavel Herrmann <morpheus.ibis@gmail.com> 6 * 7 * SPDX-License-Identifier: GPL-2.0+ 8 */ 9 10 #include <common.h> 11 #include <dm.h> 12 #include <errno.h> 13 #include <malloc.h> 14 #include <dm/device.h> 15 #include <dm/device-internal.h> 16 #include <dm/lists.h> 17 #include <dm/uclass.h> 18 #include <dm/uclass-internal.h> 19 #include <dm/util.h> 20 21 DECLARE_GLOBAL_DATA_PTR; 22 23 struct uclass *uclass_find(enum uclass_id key) 24 { 25 struct uclass *uc; 26 27 if (!gd->dm_root) 28 return NULL; 29 /* 30 * TODO(sjg@chromium.org): Optimise this, perhaps moving the found 31 * node to the start of the list, or creating a linear array mapping 32 * id to node. 33 */ 34 list_for_each_entry(uc, &gd->uclass_root, sibling_node) { 35 if (uc->uc_drv->id == key) 36 return uc; 37 38 if (uc->uc_drv->id == UCLASS_ROOT) 39 break; 40 } 41 42 return NULL; 43 } 44 45 /** 46 * uclass_add() - Create new uclass in list 47 * @id: Id number to create 48 * @ucp: Returns pointer to uclass, or NULL on error 49 * @return 0 on success, -ve on error 50 * 51 * The new uclass is added to the list. There must be only one uclass for 52 * each id. 53 */ 54 static int uclass_add(enum uclass_id id, struct uclass **ucp) 55 { 56 struct uclass_driver *uc_drv; 57 struct uclass *uc; 58 int ret; 59 60 *ucp = NULL; 61 uc_drv = lists_uclass_lookup(id); 62 if (!uc_drv) { 63 debug("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n", 64 id); 65 /* 66 * Use a strange error to make this case easier to find. When 67 * a uclass is not available it can prevent driver model from 68 * starting up and this failure is otherwise hard to debug. 69 */ 70 return -EPFNOSUPPORT; 71 } 72 uc = calloc(1, sizeof(*uc)); 73 if (!uc) 74 return -ENOMEM; 75 if (uc_drv->priv_auto_alloc_size) { 76 uc->priv = calloc(1, uc_drv->priv_auto_alloc_size); 77 if (!uc->priv) { 78 ret = -ENOMEM; 79 goto fail_mem; 80 } 81 } 82 uc->uc_drv = uc_drv; 83 INIT_LIST_HEAD(&uc->sibling_node); 84 INIT_LIST_HEAD(&uc->dev_head); 85 list_add(&uc->sibling_node, &DM_UCLASS_ROOT_NON_CONST); 86 87 if (uc_drv->init) { 88 ret = uc_drv->init(uc); 89 if (ret) 90 goto fail; 91 } 92 93 *ucp = uc; 94 95 return 0; 96 fail: 97 if (uc_drv->priv_auto_alloc_size) { 98 free(uc->priv); 99 uc->priv = NULL; 100 } 101 list_del(&uc->sibling_node); 102 fail_mem: 103 free(uc); 104 105 return ret; 106 } 107 108 int uclass_destroy(struct uclass *uc) 109 { 110 struct uclass_driver *uc_drv; 111 struct udevice *dev; 112 int ret; 113 114 /* 115 * We cannot use list_for_each_entry_safe() here. If a device in this 116 * uclass has a child device also in this uclass, it will be also be 117 * unbound (by the recursion in the call to device_unbind() below). 118 * We can loop until the list is empty. 119 */ 120 while (!list_empty(&uc->dev_head)) { 121 dev = list_first_entry(&uc->dev_head, struct udevice, 122 uclass_node); 123 ret = device_remove(dev, DM_REMOVE_NORMAL); 124 if (ret) 125 return ret; 126 ret = device_unbind(dev); 127 if (ret) 128 return ret; 129 } 130 131 uc_drv = uc->uc_drv; 132 if (uc_drv->destroy) 133 uc_drv->destroy(uc); 134 list_del(&uc->sibling_node); 135 if (uc_drv->priv_auto_alloc_size) 136 free(uc->priv); 137 free(uc); 138 139 return 0; 140 } 141 142 int uclass_get(enum uclass_id id, struct uclass **ucp) 143 { 144 struct uclass *uc; 145 146 *ucp = NULL; 147 uc = uclass_find(id); 148 if (!uc) 149 return uclass_add(id, ucp); 150 *ucp = uc; 151 152 return 0; 153 } 154 155 const char *uclass_get_name(enum uclass_id id) 156 { 157 struct uclass *uc; 158 159 if (uclass_get(id, &uc)) 160 return NULL; 161 return uc->uc_drv->name; 162 } 163 164 enum uclass_id uclass_get_by_name(const char *name) 165 { 166 int i; 167 168 for (i = 0; i < UCLASS_COUNT; i++) { 169 struct uclass_driver *uc_drv = lists_uclass_lookup(i); 170 171 if (uc_drv && !strcmp(uc_drv->name, name)) 172 return i; 173 } 174 175 return UCLASS_INVALID; 176 } 177 178 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp) 179 { 180 struct uclass *uc; 181 struct udevice *dev; 182 int ret; 183 184 *devp = NULL; 185 ret = uclass_get(id, &uc); 186 if (ret) 187 return ret; 188 if (list_empty(&uc->dev_head)) 189 return -ENODEV; 190 191 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 192 if (!index--) { 193 *devp = dev; 194 return 0; 195 } 196 } 197 198 return -ENODEV; 199 } 200 201 int uclass_find_first_device(enum uclass_id id, struct udevice **devp) 202 { 203 struct uclass *uc; 204 int ret; 205 206 *devp = NULL; 207 ret = uclass_get(id, &uc); 208 if (ret) 209 return ret; 210 if (list_empty(&uc->dev_head)) 211 return 0; 212 213 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node); 214 215 return 0; 216 } 217 218 int uclass_find_next_device(struct udevice **devp) 219 { 220 struct udevice *dev = *devp; 221 222 *devp = NULL; 223 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head)) 224 return 0; 225 226 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node); 227 228 return 0; 229 } 230 231 int uclass_find_device_by_name(enum uclass_id id, const char *name, 232 struct udevice **devp) 233 { 234 struct uclass *uc; 235 struct udevice *dev; 236 int ret; 237 238 *devp = NULL; 239 if (!name) 240 return -EINVAL; 241 ret = uclass_get(id, &uc); 242 if (ret) 243 return ret; 244 245 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 246 if (!strncmp(dev->name, name, strlen(name))) { 247 *devp = dev; 248 return 0; 249 } 250 } 251 252 return -ENODEV; 253 } 254 255 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq, 256 bool find_req_seq, struct udevice **devp) 257 { 258 struct uclass *uc; 259 struct udevice *dev; 260 int ret; 261 262 *devp = NULL; 263 pr_debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq); 264 if (seq_or_req_seq == -1) 265 return -ENODEV; 266 ret = uclass_get(id, &uc); 267 if (ret) 268 return ret; 269 270 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 271 pr_debug(" - %d %d '%s'\n", dev->req_seq, dev->seq, dev->name); 272 if ((find_req_seq ? dev->req_seq : dev->seq) == 273 seq_or_req_seq) { 274 *devp = dev; 275 pr_debug(" - found\n"); 276 return 0; 277 } 278 } 279 pr_debug(" - not found\n"); 280 281 return -ENODEV; 282 } 283 284 int uclass_find_device_by_of_offset(enum uclass_id id, int node, 285 struct udevice **devp) 286 { 287 struct uclass *uc; 288 struct udevice *dev; 289 int ret; 290 291 *devp = NULL; 292 if (node < 0) 293 return -ENODEV; 294 ret = uclass_get(id, &uc); 295 if (ret) 296 return ret; 297 298 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 299 if (dev_of_offset(dev) == node) { 300 *devp = dev; 301 return 0; 302 } 303 } 304 305 return -ENODEV; 306 } 307 308 int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node, 309 struct udevice **devp) 310 { 311 struct uclass *uc; 312 struct udevice *dev; 313 int ret; 314 315 *devp = NULL; 316 if (!ofnode_valid(node)) 317 return -ENODEV; 318 ret = uclass_get(id, &uc); 319 if (ret) 320 return ret; 321 322 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 323 if (ofnode_equal(dev_ofnode(dev), node)) { 324 *devp = dev; 325 return 0; 326 } 327 } 328 329 return -ENODEV; 330 } 331 332 #if CONFIG_IS_ENABLED(OF_CONTROL) 333 static int uclass_find_device_by_phandle(enum uclass_id id, 334 struct udevice *parent, 335 const char *name, 336 struct udevice **devp) 337 { 338 struct udevice *dev; 339 struct uclass *uc; 340 int find_phandle; 341 int ret; 342 343 *devp = NULL; 344 find_phandle = dev_read_u32_default(parent, name, -1); 345 if (find_phandle <= 0) 346 return -ENOENT; 347 ret = uclass_get(id, &uc); 348 if (ret) 349 return ret; 350 351 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 352 uint phandle; 353 354 phandle = dev_read_phandle(dev); 355 356 if (phandle == find_phandle) { 357 *devp = dev; 358 return 0; 359 } 360 } 361 362 return -ENODEV; 363 } 364 #endif 365 366 int uclass_get_device_by_driver(enum uclass_id id, 367 const struct driver *find_drv, 368 struct udevice **devp) 369 { 370 struct udevice *dev; 371 struct uclass *uc; 372 int ret; 373 374 ret = uclass_get(id, &uc); 375 if (ret) 376 return ret; 377 378 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 379 if (dev->driver == find_drv) 380 return uclass_get_device_tail(dev, 0, devp); 381 } 382 383 return -ENODEV; 384 } 385 386 int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp) 387 { 388 if (ret) 389 return ret; 390 391 assert(dev); 392 ret = device_probe(dev); 393 if (ret) 394 return ret; 395 396 *devp = dev; 397 398 return 0; 399 } 400 401 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp) 402 { 403 struct udevice *dev; 404 int ret; 405 406 *devp = NULL; 407 ret = uclass_find_device(id, index, &dev); 408 return uclass_get_device_tail(dev, ret, devp); 409 } 410 411 int uclass_get_device_by_name(enum uclass_id id, const char *name, 412 struct udevice **devp) 413 { 414 struct udevice *dev; 415 int ret; 416 417 *devp = NULL; 418 ret = uclass_find_device_by_name(id, name, &dev); 419 return uclass_get_device_tail(dev, ret, devp); 420 } 421 422 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp) 423 { 424 struct udevice *dev; 425 int ret; 426 427 *devp = NULL; 428 ret = uclass_find_device_by_seq(id, seq, false, &dev); 429 if (ret == -ENODEV) { 430 /* 431 * We didn't find it in probed devices. See if there is one 432 * that will request this seq if probed. 433 */ 434 ret = uclass_find_device_by_seq(id, seq, true, &dev); 435 } 436 return uclass_get_device_tail(dev, ret, devp); 437 } 438 439 int uclass_get_device_by_of_offset(enum uclass_id id, int node, 440 struct udevice **devp) 441 { 442 struct udevice *dev; 443 int ret; 444 445 *devp = NULL; 446 ret = uclass_find_device_by_of_offset(id, node, &dev); 447 return uclass_get_device_tail(dev, ret, devp); 448 } 449 450 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node, 451 struct udevice **devp) 452 { 453 struct udevice *dev; 454 int ret; 455 456 *devp = NULL; 457 ret = uclass_find_device_by_ofnode(id, node, &dev); 458 459 return uclass_get_device_tail(dev, ret, devp); 460 } 461 462 #if CONFIG_IS_ENABLED(OF_CONTROL) 463 int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id, 464 struct udevice **devp) 465 { 466 struct udevice *dev; 467 struct uclass *uc; 468 int ret; 469 470 *devp = NULL; 471 ret = uclass_get(id, &uc); 472 if (ret) 473 return ret; 474 475 ret = -ENODEV; 476 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 477 uint phandle; 478 479 phandle = dev_read_phandle(dev); 480 481 if (phandle == phandle_id) { 482 *devp = dev; 483 ret = 0; 484 break; 485 } 486 } 487 488 return uclass_get_device_tail(dev, ret, devp); 489 } 490 491 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent, 492 const char *name, struct udevice **devp) 493 { 494 struct udevice *dev; 495 int ret; 496 497 *devp = NULL; 498 ret = uclass_find_device_by_phandle(id, parent, name, &dev); 499 return uclass_get_device_tail(dev, ret, devp); 500 } 501 #endif 502 503 int uclass_first_device(enum uclass_id id, struct udevice **devp) 504 { 505 struct udevice *dev; 506 int ret; 507 508 *devp = NULL; 509 ret = uclass_find_first_device(id, &dev); 510 if (!dev) 511 return 0; 512 return uclass_get_device_tail(dev, ret, devp); 513 } 514 515 int uclass_first_device_err(enum uclass_id id, struct udevice **devp) 516 { 517 int ret; 518 519 ret = uclass_first_device(id, devp); 520 if (ret) 521 return ret; 522 else if (!*devp) 523 return -ENODEV; 524 525 return 0; 526 } 527 528 int uclass_next_device(struct udevice **devp) 529 { 530 struct udevice *dev = *devp; 531 int ret; 532 533 *devp = NULL; 534 ret = uclass_find_next_device(&dev); 535 if (!dev) 536 return 0; 537 return uclass_get_device_tail(dev, ret, devp); 538 } 539 540 int uclass_first_device_check(enum uclass_id id, struct udevice **devp) 541 { 542 int ret; 543 544 *devp = NULL; 545 ret = uclass_find_first_device(id, devp); 546 if (ret) 547 return ret; 548 if (!*devp) 549 return 0; 550 551 return device_probe(*devp); 552 } 553 554 int uclass_next_device_check(struct udevice **devp) 555 { 556 int ret; 557 558 ret = uclass_find_next_device(devp); 559 if (ret) 560 return ret; 561 if (!*devp) 562 return 0; 563 564 return device_probe(*devp); 565 } 566 567 int uclass_bind_device(struct udevice *dev) 568 { 569 struct uclass *uc; 570 int ret; 571 572 uc = dev->uclass; 573 list_add_tail(&dev->uclass_node, &uc->dev_head); 574 575 if (dev->parent) { 576 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv; 577 578 if (uc_drv->child_post_bind) { 579 ret = uc_drv->child_post_bind(dev); 580 if (ret) 581 goto err; 582 } 583 } 584 585 return 0; 586 err: 587 /* There is no need to undo the parent's post_bind call */ 588 list_del(&dev->uclass_node); 589 590 return ret; 591 } 592 593 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) 594 int uclass_unbind_device(struct udevice *dev) 595 { 596 struct uclass *uc; 597 int ret; 598 599 uc = dev->uclass; 600 if (uc->uc_drv->pre_unbind) { 601 ret = uc->uc_drv->pre_unbind(dev); 602 if (ret) 603 return ret; 604 } 605 606 list_del(&dev->uclass_node); 607 return 0; 608 } 609 #endif 610 611 int uclass_resolve_seq(struct udevice *dev) 612 { 613 struct udevice *dup; 614 int seq; 615 int ret; 616 617 assert(dev->seq == -1); 618 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq, 619 false, &dup); 620 if (!ret) { 621 dm_warn("Device '%s': seq %d is in use by '%s'\n", 622 dev->name, dev->req_seq, dup->name); 623 } else if (ret == -ENODEV) { 624 /* Our requested sequence number is available */ 625 if (dev->req_seq != -1) 626 return dev->req_seq; 627 } else { 628 return ret; 629 } 630 631 for (seq = 0; seq < DM_MAX_SEQ; seq++) { 632 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq, 633 false, &dup); 634 if (ret == -ENODEV) 635 break; 636 if (ret) 637 return ret; 638 } 639 return seq; 640 } 641 642 int uclass_pre_probe_device(struct udevice *dev) 643 { 644 struct uclass_driver *uc_drv; 645 int ret; 646 647 uc_drv = dev->uclass->uc_drv; 648 if (uc_drv->pre_probe) { 649 ret = uc_drv->pre_probe(dev); 650 if (ret) 651 return ret; 652 } 653 654 if (!dev->parent) 655 return 0; 656 uc_drv = dev->parent->uclass->uc_drv; 657 if (uc_drv->child_pre_probe) 658 return uc_drv->child_pre_probe(dev); 659 660 return 0; 661 } 662 663 int uclass_post_probe_device(struct udevice *dev) 664 { 665 struct uclass_driver *uc_drv = dev->uclass->uc_drv; 666 667 if (uc_drv->post_probe) 668 return uc_drv->post_probe(dev); 669 670 return 0; 671 } 672 673 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) 674 int uclass_pre_remove_device(struct udevice *dev) 675 { 676 struct uclass *uc; 677 int ret; 678 679 uc = dev->uclass; 680 if (uc->uc_drv->pre_remove) { 681 ret = uc->uc_drv->pre_remove(dev); 682 if (ret) 683 return ret; 684 } 685 686 return 0; 687 } 688 #endif 689 690 UCLASS_DRIVER(nop) = { 691 .id = UCLASS_NOP, 692 .name = "nop", 693 }; 694