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