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 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp) 165 { 166 struct uclass *uc; 167 struct udevice *dev; 168 int ret; 169 170 *devp = NULL; 171 ret = uclass_get(id, &uc); 172 if (ret) 173 return ret; 174 if (list_empty(&uc->dev_head)) 175 return -ENODEV; 176 177 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 178 if (!index--) { 179 *devp = dev; 180 return 0; 181 } 182 } 183 184 return -ENODEV; 185 } 186 187 int uclass_find_first_device(enum uclass_id id, struct udevice **devp) 188 { 189 struct uclass *uc; 190 int ret; 191 192 *devp = NULL; 193 ret = uclass_get(id, &uc); 194 if (ret) 195 return ret; 196 if (list_empty(&uc->dev_head)) 197 return 0; 198 199 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node); 200 201 return 0; 202 } 203 204 int uclass_find_next_device(struct udevice **devp) 205 { 206 struct udevice *dev = *devp; 207 208 *devp = NULL; 209 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head)) 210 return 0; 211 212 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node); 213 214 return 0; 215 } 216 217 int uclass_find_device_by_name(enum uclass_id id, const char *name, 218 struct udevice **devp) 219 { 220 struct uclass *uc; 221 struct udevice *dev; 222 int ret; 223 224 *devp = NULL; 225 if (!name) 226 return -EINVAL; 227 ret = uclass_get(id, &uc); 228 if (ret) 229 return ret; 230 231 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 232 if (!strncmp(dev->name, name, strlen(name))) { 233 *devp = dev; 234 return 0; 235 } 236 } 237 238 return -ENODEV; 239 } 240 241 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq, 242 bool find_req_seq, struct udevice **devp) 243 { 244 struct uclass *uc; 245 struct udevice *dev; 246 int ret; 247 248 *devp = NULL; 249 debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq); 250 if (seq_or_req_seq == -1) 251 return -ENODEV; 252 ret = uclass_get(id, &uc); 253 if (ret) 254 return ret; 255 256 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 257 debug(" - %d %d '%s'\n", dev->req_seq, dev->seq, dev->name); 258 if ((find_req_seq ? dev->req_seq : dev->seq) == 259 seq_or_req_seq) { 260 *devp = dev; 261 debug(" - found\n"); 262 return 0; 263 } 264 } 265 debug(" - not found\n"); 266 267 return -ENODEV; 268 } 269 270 int uclass_find_device_by_of_offset(enum uclass_id id, int node, 271 struct udevice **devp) 272 { 273 struct uclass *uc; 274 struct udevice *dev; 275 int ret; 276 277 *devp = NULL; 278 if (node < 0) 279 return -ENODEV; 280 ret = uclass_get(id, &uc); 281 if (ret) 282 return ret; 283 284 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 285 if (dev_of_offset(dev) == node) { 286 *devp = dev; 287 return 0; 288 } 289 } 290 291 return -ENODEV; 292 } 293 294 int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node, 295 struct udevice **devp) 296 { 297 struct uclass *uc; 298 struct udevice *dev; 299 int ret; 300 301 *devp = NULL; 302 if (!ofnode_valid(node)) 303 return -ENODEV; 304 ret = uclass_get(id, &uc); 305 if (ret) 306 return ret; 307 308 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 309 if (ofnode_equal(dev_ofnode(dev), node)) { 310 *devp = dev; 311 return 0; 312 } 313 } 314 315 return -ENODEV; 316 } 317 318 #if CONFIG_IS_ENABLED(OF_CONTROL) 319 static int uclass_find_device_by_phandle(enum uclass_id id, 320 struct udevice *parent, 321 const char *name, 322 struct udevice **devp) 323 { 324 struct udevice *dev; 325 struct uclass *uc; 326 int find_phandle; 327 int ret; 328 329 *devp = NULL; 330 find_phandle = dev_read_u32_default(parent, name, -1); 331 if (find_phandle <= 0) 332 return -ENOENT; 333 ret = uclass_get(id, &uc); 334 if (ret) 335 return ret; 336 337 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 338 uint phandle; 339 340 phandle = dev_read_phandle(dev); 341 342 if (phandle == find_phandle) { 343 *devp = dev; 344 return 0; 345 } 346 } 347 348 return -ENODEV; 349 } 350 #endif 351 352 int uclass_get_device_by_driver(enum uclass_id id, 353 const struct driver *find_drv, 354 struct udevice **devp) 355 { 356 struct udevice *dev; 357 struct uclass *uc; 358 int ret; 359 360 ret = uclass_get(id, &uc); 361 if (ret) 362 return ret; 363 364 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 365 if (dev->driver == find_drv) 366 return uclass_get_device_tail(dev, 0, devp); 367 } 368 369 return -ENODEV; 370 } 371 372 int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp) 373 { 374 if (ret) 375 return ret; 376 377 assert(dev); 378 ret = device_probe(dev); 379 if (ret) 380 return ret; 381 382 *devp = dev; 383 384 return 0; 385 } 386 387 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp) 388 { 389 struct udevice *dev; 390 int ret; 391 392 *devp = NULL; 393 ret = uclass_find_device(id, index, &dev); 394 return uclass_get_device_tail(dev, ret, devp); 395 } 396 397 int uclass_get_device_by_name(enum uclass_id id, const char *name, 398 struct udevice **devp) 399 { 400 struct udevice *dev; 401 int ret; 402 403 *devp = NULL; 404 ret = uclass_find_device_by_name(id, name, &dev); 405 return uclass_get_device_tail(dev, ret, devp); 406 } 407 408 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp) 409 { 410 struct udevice *dev; 411 int ret; 412 413 *devp = NULL; 414 ret = uclass_find_device_by_seq(id, seq, false, &dev); 415 if (ret == -ENODEV) { 416 /* 417 * We didn't find it in probed devices. See if there is one 418 * that will request this seq if probed. 419 */ 420 ret = uclass_find_device_by_seq(id, seq, true, &dev); 421 } 422 return uclass_get_device_tail(dev, ret, devp); 423 } 424 425 int uclass_get_device_by_of_offset(enum uclass_id id, int node, 426 struct udevice **devp) 427 { 428 struct udevice *dev; 429 int ret; 430 431 *devp = NULL; 432 ret = uclass_find_device_by_of_offset(id, node, &dev); 433 return uclass_get_device_tail(dev, ret, devp); 434 } 435 436 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node, 437 struct udevice **devp) 438 { 439 struct udevice *dev; 440 int ret; 441 442 *devp = NULL; 443 ret = uclass_find_device_by_ofnode(id, node, &dev); 444 445 return uclass_get_device_tail(dev, ret, devp); 446 } 447 448 #if CONFIG_IS_ENABLED(OF_CONTROL) 449 int uclass_get_device_by_phandle_id(enum uclass_id id, int phandle_id, 450 struct udevice **devp) 451 { 452 struct udevice *dev; 453 struct uclass *uc; 454 int ret; 455 456 *devp = NULL; 457 ret = uclass_get(id, &uc); 458 if (ret) 459 return ret; 460 461 ret = -ENODEV; 462 list_for_each_entry(dev, &uc->dev_head, uclass_node) { 463 uint phandle; 464 465 phandle = dev_read_phandle(dev); 466 467 if (phandle == phandle_id) { 468 *devp = dev; 469 ret = 0; 470 break; 471 } 472 } 473 474 return uclass_get_device_tail(dev, ret, devp); 475 } 476 477 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent, 478 const char *name, struct udevice **devp) 479 { 480 struct udevice *dev; 481 int ret; 482 483 *devp = NULL; 484 ret = uclass_find_device_by_phandle(id, parent, name, &dev); 485 return uclass_get_device_tail(dev, ret, devp); 486 } 487 #endif 488 489 int uclass_first_device(enum uclass_id id, struct udevice **devp) 490 { 491 struct udevice *dev; 492 int ret; 493 494 *devp = NULL; 495 ret = uclass_find_first_device(id, &dev); 496 if (!dev) 497 return 0; 498 return uclass_get_device_tail(dev, ret, devp); 499 } 500 501 int uclass_first_device_err(enum uclass_id id, struct udevice **devp) 502 { 503 int ret; 504 505 ret = uclass_first_device(id, devp); 506 if (ret) 507 return ret; 508 else if (!*devp) 509 return -ENODEV; 510 511 return 0; 512 } 513 514 int uclass_next_device(struct udevice **devp) 515 { 516 struct udevice *dev = *devp; 517 int ret; 518 519 *devp = NULL; 520 ret = uclass_find_next_device(&dev); 521 if (!dev) 522 return 0; 523 return uclass_get_device_tail(dev, ret, devp); 524 } 525 526 int uclass_first_device_check(enum uclass_id id, struct udevice **devp) 527 { 528 int ret; 529 530 *devp = NULL; 531 ret = uclass_find_first_device(id, devp); 532 if (ret) 533 return ret; 534 if (!*devp) 535 return 0; 536 537 return device_probe(*devp); 538 } 539 540 int uclass_next_device_check(struct udevice **devp) 541 { 542 int ret; 543 544 ret = uclass_find_next_device(devp); 545 if (ret) 546 return ret; 547 if (!*devp) 548 return 0; 549 550 return device_probe(*devp); 551 } 552 553 int uclass_bind_device(struct udevice *dev) 554 { 555 struct uclass *uc; 556 int ret; 557 558 uc = dev->uclass; 559 list_add_tail(&dev->uclass_node, &uc->dev_head); 560 561 if (dev->parent) { 562 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv; 563 564 if (uc_drv->child_post_bind) { 565 ret = uc_drv->child_post_bind(dev); 566 if (ret) 567 goto err; 568 } 569 } 570 571 return 0; 572 err: 573 /* There is no need to undo the parent's post_bind call */ 574 list_del(&dev->uclass_node); 575 576 return ret; 577 } 578 579 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) 580 int uclass_unbind_device(struct udevice *dev) 581 { 582 struct uclass *uc; 583 int ret; 584 585 uc = dev->uclass; 586 if (uc->uc_drv->pre_unbind) { 587 ret = uc->uc_drv->pre_unbind(dev); 588 if (ret) 589 return ret; 590 } 591 592 list_del(&dev->uclass_node); 593 return 0; 594 } 595 #endif 596 597 int uclass_resolve_seq(struct udevice *dev) 598 { 599 struct udevice *dup; 600 int seq; 601 int ret; 602 603 assert(dev->seq == -1); 604 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq, 605 false, &dup); 606 if (!ret) { 607 dm_warn("Device '%s': seq %d is in use by '%s'\n", 608 dev->name, dev->req_seq, dup->name); 609 } else if (ret == -ENODEV) { 610 /* Our requested sequence number is available */ 611 if (dev->req_seq != -1) 612 return dev->req_seq; 613 } else { 614 return ret; 615 } 616 617 for (seq = 0; seq < DM_MAX_SEQ; seq++) { 618 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq, 619 false, &dup); 620 if (ret == -ENODEV) 621 break; 622 if (ret) 623 return ret; 624 } 625 return seq; 626 } 627 628 int uclass_pre_probe_device(struct udevice *dev) 629 { 630 struct uclass_driver *uc_drv; 631 int ret; 632 633 uc_drv = dev->uclass->uc_drv; 634 if (uc_drv->pre_probe) { 635 ret = uc_drv->pre_probe(dev); 636 if (ret) 637 return ret; 638 } 639 640 if (!dev->parent) 641 return 0; 642 uc_drv = dev->parent->uclass->uc_drv; 643 if (uc_drv->child_pre_probe) 644 return uc_drv->child_pre_probe(dev); 645 646 return 0; 647 } 648 649 int uclass_post_probe_device(struct udevice *dev) 650 { 651 struct uclass_driver *uc_drv = dev->uclass->uc_drv; 652 653 if (uc_drv->post_probe) 654 return uc_drv->post_probe(dev); 655 656 return 0; 657 } 658 659 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) 660 int uclass_pre_remove_device(struct udevice *dev) 661 { 662 struct uclass *uc; 663 int ret; 664 665 uc = dev->uclass; 666 if (uc->uc_drv->pre_remove) { 667 ret = uc->uc_drv->pre_remove(dev); 668 if (ret) 669 return ret; 670 } 671 672 return 0; 673 } 674 #endif 675