drivers/core/uclass.c

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