drivers/core/device.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Device manager
   4  *
   5  * Copyright (c) 2013 Google, Inc
   6  *
   7  * (C) Copyright 2012
   8  * Pavel Herrmann <morpheus.ibis@gmail.com>
   9  */
  10
  11 #include <common.h>
  12 #include <asm/io.h>
  13 #include <clk.h>
  14 #include <fdtdec.h>
  15 #include <fdt_support.h>
  16 #include <malloc.h>
  17 #include <dm/device.h>
  18 #include <dm/device-internal.h>
  19 #include <dm/lists.h>
  20 #include <dm/of_access.h>
  21 #include <dm/pinctrl.h>
  22 #include <dm/platdata.h>
  23 #include <dm/read.h>
  24 #include <dm/uclass.h>
  25 #include <dm/uclass-internal.h>
  26 #include <dm/util.h>
  27 #include <linux/err.h>
  28 #include <linux/list.h>
  29
  30 DECLARE_GLOBAL_DATA_PTR;
  31
  32 static int device_bind_common(struct udevice *parent, const struct driver *drv,
  33                               const char *name, void *platdata,
  34                               ulong driver_data, ofnode node,
  35                               uint of_platdata_size, struct udevice **devp)
  36 {
  37         struct udevice *dev;
  38         struct uclass *uc;
  39         int size, ret = 0;
  40
  41         if (devp)
  42                 *devp = NULL;
  43         if (!name)
  44                 return -EINVAL;
  45
  46         ret = uclass_get(drv->id, &uc);
  47         if (ret) {
  48                 debug("Missing uclass for driver %s\n", drv->name);
  49                 return ret;
  50         }
  51
  52         dev = calloc(1, sizeof(struct udevice));
  53         if (!dev)
  54                 return -ENOMEM;
  55
  56         INIT_LIST_HEAD(&dev->sibling_node);
  57         INIT_LIST_HEAD(&dev->child_head);
  58         INIT_LIST_HEAD(&dev->uclass_node);
  59 #ifdef CONFIG_DEVRES
  60         INIT_LIST_HEAD(&dev->devres_head);
  61 #endif
  62         dev->platdata = platdata;
  63         dev->driver_data = driver_data;
  64         dev->name = name;
  65         dev->node = node;
  66         dev->parent = parent;
  67         dev->driver = drv;
  68         dev->uclass = uc;
  69
  70         dev->seq = -1;
  71         dev->req_seq = -1;
  72         if (CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(DM_SEQ_ALIAS)) {
  73                 /*
  74                  * Some devices, such as a SPI bus, I2C bus and serial ports
  75                  * are numbered using aliases.
  76                  *
  77                  * This is just a 'requested' sequence, and will be
  78                  * resolved (and ->seq updated) when the device is probed.
  79                  */
  80                 if (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS) {
  81                         if (uc->uc_drv->name && ofnode_valid(node)) {
  82                                 dev_read_alias_seq(dev, &dev->req_seq);
  83                         }
  84                 }
  85         }
  86
  87         if (drv->platdata_auto_alloc_size) {
  88                 bool alloc = !platdata;
  89
  90                 if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
  91                         if (of_platdata_size) {
  92                                 dev->flags |= DM_FLAG_OF_PLATDATA;
  93                                 if (of_platdata_size <
  94                                                 drv->platdata_auto_alloc_size)
  95                                         alloc = true;
  96                         }
  97                 }
  98                 if (alloc) {
  99                         dev->flags |= DM_FLAG_ALLOC_PDATA;
 100                         dev->platdata = calloc(1,
 101                                                drv->platdata_auto_alloc_size);
 102                         if (!dev->platdata) {
 103                                 ret = -ENOMEM;
 104                                 goto fail_alloc1;
 105                         }
 106                         if (CONFIG_IS_ENABLED(OF_PLATDATA) && platdata) {
 107                                 memcpy(dev->platdata, platdata,
 108                                        of_platdata_size);
 109                         }
 110                 }
 111         }
 112
 113         size = uc->uc_drv->per_device_platdata_auto_alloc_size;
 114         if (size) {
 115                 dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
 116                 dev->uclass_platdata = calloc(1, size);
 117                 if (!dev->uclass_platdata) {
 118                         ret = -ENOMEM;
 119                         goto fail_alloc2;
 120                 }
 121         }
 122
 123         if (parent) {
 124                 size = parent->driver->per_child_platdata_auto_alloc_size;
 125                 if (!size) {
 126                         size = parent->uclass->uc_drv->
 127                                         per_child_platdata_auto_alloc_size;
 128                 }
 129                 if (size) {
 130                         dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
 131                         dev->parent_platdata = calloc(1, size);
 132                         if (!dev->parent_platdata) {
 133                                 ret = -ENOMEM;
 134                                 goto fail_alloc3;
 135                         }
 136                 }
 137         }
 138
 139         /* put dev into parent's successor list */
 140         if (parent)
 141                 list_add_tail(&dev->sibling_node, &parent->child_head);
 142
 143         ret = uclass_bind_device(dev);
 144         if (ret)
 145                 goto fail_uclass_bind;
 146
 147         /* if we fail to bind we remove device from successors and free it */
 148         if (drv->bind) {
 149                 ret = drv->bind(dev);
 150                 if (ret)
 151                         goto fail_bind;
 152         }
 153         if (parent && parent->driver->child_post_bind) {
 154                 ret = parent->driver->child_post_bind(dev);
 155                 if (ret)
 156                         goto fail_child_post_bind;
 157         }
 158         if (uc->uc_drv->post_bind) {
 159                 ret = uc->uc_drv->post_bind(dev);
 160                 if (ret)
 161                         goto fail_uclass_post_bind;
 162         }
 163
 164         if (parent)
 165                 pr_debug("Bound device %s to %s\n", dev->name, parent->name);
 166         if (devp)
 167                 *devp = dev;
 168
 169         dev->flags |= DM_FLAG_BOUND;
 170
 171         return 0;
 172
 173 fail_uclass_post_bind:
 174         /* There is no child unbind() method, so no clean-up required */
 175 fail_child_post_bind:
 176         if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
 177                 if (drv->unbind && drv->unbind(dev)) {
 178                         dm_warn("unbind() method failed on dev '%s' on error path\n",
 179                                 dev->name);
 180                 }
 181         }
 182
 183 fail_bind:
 184         if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
 185                 if (uclass_unbind_device(dev)) {
 186                         dm_warn("Failed to unbind dev '%s' on error path\n",
 187                                 dev->name);
 188                 }
 189         }
 190 fail_uclass_bind:
 191         if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
 192                 list_del(&dev->sibling_node);
 193                 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
 194                         free(dev->parent_platdata);
 195                         dev->parent_platdata = NULL;
 196                 }
 197         }
 198 fail_alloc3:
 199         if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
 200                 free(dev->uclass_platdata);
 201                 dev->uclass_platdata = NULL;
 202         }
 203 fail_alloc2:
 204         if (dev->flags & DM_FLAG_ALLOC_PDATA) {
 205                 free(dev->platdata);
 206                 dev->platdata = NULL;
 207         }
 208 fail_alloc1:
 209         devres_release_all(dev);
 210
 211         free(dev);
 212
 213         return ret;
 214 }
 215
 216 int device_bind_with_driver_data(struct udevice *parent,
 217                                  const struct driver *drv, const char *name,
 218                                  ulong driver_data, ofnode node,
 219                                  struct udevice **devp)
 220 {
 221         return device_bind_common(parent, drv, name, NULL, driver_data, node,
 222                                   0, devp);
 223 }
 224
 225 int device_bind(struct udevice *parent, const struct driver *drv,
 226                 const char *name, void *platdata, int of_offset,
 227                 struct udevice **devp)
 228 {
 229         return device_bind_common(parent, drv, name, platdata, 0,
 230                                   offset_to_ofnode(of_offset), 0, devp);
 231 }
 232
 233 int device_bind_ofnode(struct udevice *parent, const struct driver *drv,
 234                        const char *name, void *platdata, ofnode node,
 235                        struct udevice **devp)
 236 {
 237         return device_bind_common(parent, drv, name, platdata, 0, node, 0,
 238                                   devp);
 239 }
 240
 241 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
 242                         const struct driver_info *info, struct udevice **devp)
 243 {
 244         struct driver *drv;
 245         uint platdata_size = 0;
 246
 247         drv = lists_driver_lookup_name(info->name);
 248         if (!drv)
 249                 return -ENOENT;
 250         if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
 251                 return -EPERM;
 252
 253 #if CONFIG_IS_ENABLED(OF_PLATDATA)
 254         platdata_size = info->platdata_size;
 255 #endif
 256         return device_bind_common(parent, drv, info->name,
 257                         (void *)info->platdata, 0, ofnode_null(), platdata_size,
 258                         devp);
 259 }
 260
 261 static void *alloc_priv(int size, uint flags)
 262 {
 263         void *priv;
 264
 265         if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
 266                 size = ROUND(size, ARCH_DMA_MINALIGN);
 267                 priv = memalign(ARCH_DMA_MINALIGN, size);
 268                 if (priv) {
 269                         memset(priv, '\0', size);
 270
 271                         /*
 272                          * Ensure that the zero bytes are flushed to memory.
 273                          * This prevents problems if the driver uses this as
 274                          * both an input and an output buffer:
 275                          *
 276                          * 1. Zeroes written to buffer (here) and sit in the
 277                          *      cache
 278                          * 2. Driver issues a read command to DMA
 279                          * 3. CPU runs out of cache space and evicts some cache
 280                          *      data in the buffer, writing zeroes to RAM from
 281                          *      the memset() above
 282                          * 4. DMA completes
 283                          * 5. Buffer now has some DMA data and some zeroes
 284                          * 6. Data being read is now incorrect
 285                          *
 286                          * To prevent this, ensure that the cache is clean
 287                          * within this range at the start. The driver can then
 288                          * use normal flush-after-write, invalidate-before-read
 289                          * procedures.
 290                          *
 291                          * TODO(sjg@chromium.org): Drop this microblaze
 292                          * exception.
 293                          */
 294 #ifndef CONFIG_MICROBLAZE
 295                         flush_dcache_range((ulong)priv, (ulong)priv + size);
 296 #endif
 297                 }
 298         } else {
 299                 priv = calloc(1, size);
 300         }
 301
 302         return priv;
 303 }
 304
 305 int device_probe(struct udevice *dev)
 306 {
 307         const struct driver *drv;
 308         int size = 0;
 309         int ret;
 310         int seq;
 311
 312         if (!dev)
 313                 return -EINVAL;
 314
 315         if (dev->flags & DM_FLAG_ACTIVATED)
 316                 return 0;
 317
 318         drv = dev->driver;
 319         assert(drv);
 320
 321         /* Allocate private data if requested and not reentered */
 322         if (drv->priv_auto_alloc_size && !dev->priv) {
 323                 dev->priv = alloc_priv(drv->priv_auto_alloc_size, drv->flags);
 324                 if (!dev->priv) {
 325                         ret = -ENOMEM;
 326                         goto fail;
 327                 }
 328         }
 329         /* Allocate private data if requested and not reentered */
 330         size = dev->uclass->uc_drv->per_device_auto_alloc_size;
 331         if (size && !dev->uclass_priv) {
 332                 dev->uclass_priv = calloc(1, size);
 333                 if (!dev->uclass_priv) {
 334                         ret = -ENOMEM;
 335                         goto fail;
 336                 }
 337         }
 338
 339         /* Ensure all parents are probed */
 340         if (dev->parent) {
 341                 size = dev->parent->driver->per_child_auto_alloc_size;
 342                 if (!size) {
 343                         size = dev->parent->uclass->uc_drv->
 344                                         per_child_auto_alloc_size;
 345                 }
 346                 if (size && !dev->parent_priv) {
 347                         dev->parent_priv = alloc_priv(size, drv->flags);
 348                         if (!dev->parent_priv) {
 349                                 ret = -ENOMEM;
 350                                 goto fail;
 351                         }
 352                 }
 353
 354                 ret = device_probe(dev->parent);
 355                 if (ret)
 356                         goto fail;
 357
 358                 /*
 359                  * The device might have already been probed during
 360                  * the call to device_probe() on its parent device
 361                  * (e.g. PCI bridge devices). Test the flags again
 362                  * so that we don't mess up the device.
 363                  */
 364                 if (dev->flags & DM_FLAG_ACTIVATED)
 365                         return 0;
 366         }
 367
 368         seq = uclass_resolve_seq(dev);
 369         if (seq < 0) {
 370                 ret = seq;
 371                 goto fail;
 372         }
 373         dev->seq = seq;
 374
 375         dev->flags |= DM_FLAG_ACTIVATED;
 376
 377         /*
 378          * Process pinctrl for everything except the root device, and
 379          * continue regardless of the result of pinctrl. Don't process pinctrl
 380          * settings for pinctrl devices since the device may not yet be
 381          * probed.
 382          */
 383         if (dev->parent && device_get_uclass_id(dev) != UCLASS_PINCTRL)
 384                 pinctrl_select_state(dev, "default");
 385
 386         ret = uclass_pre_probe_device(dev);
 387         if (ret)
 388                 goto fail;
 389
 390         if (dev->parent && dev->parent->driver->child_pre_probe) {
 391                 ret = dev->parent->driver->child_pre_probe(dev);
 392                 if (ret)
 393                         goto fail;
 394         }
 395
 396         if (drv->ofdata_to_platdata && dev_has_of_node(dev)) {
 397                 ret = drv->ofdata_to_platdata(dev);
 398                 if (ret)
 399                         goto fail;
 400         }
 401
 402         /* Process 'assigned-{clocks/clock-parents/clock-rates}' properties */
 403         ret = clk_set_defaults(dev);
 404         if (ret)
 405                 goto fail;
 406
 407         if (drv->probe) {
 408                 ret = drv->probe(dev);
 409                 if (ret) {
 410                         dev->flags &= ~DM_FLAG_ACTIVATED;
 411                         goto fail;
 412                 }
 413         }
 414
 415         ret = uclass_post_probe_device(dev);
 416         if (ret)
 417                 goto fail_uclass;
 418
 419         if (dev->parent && device_get_uclass_id(dev) == UCLASS_PINCTRL)
 420                 pinctrl_select_state(dev, "default");
 421
 422         return 0;
 423 fail_uclass:
 424         if (device_remove(dev, DM_REMOVE_NORMAL)) {
 425                 dm_warn("%s: Device '%s' failed to remove on error path\n",
 426                         __func__, dev->name);
 427         }
 428 fail:
 429         dev->flags &= ~DM_FLAG_ACTIVATED;
 430
 431         dev->seq = -1;
 432         device_free(dev);
 433
 434         return ret;
 435 }
 436
 437 void *dev_get_platdata(struct udevice *dev)
 438 {
 439         if (!dev) {
 440                 dm_warn("%s: null device\n", __func__);
 441                 return NULL;
 442         }
 443
 444         return dev->platdata;
 445 }
 446
 447 void *dev_get_parent_platdata(struct udevice *dev)
 448 {
 449         if (!dev) {
 450                 dm_warn("%s: null device\n", __func__);
 451                 return NULL;
 452         }
 453
 454         return dev->parent_platdata;
 455 }
 456
 457 void *dev_get_uclass_platdata(struct udevice *dev)
 458 {
 459         if (!dev) {
 460                 dm_warn("%s: null device\n", __func__);
 461                 return NULL;
 462         }
 463
 464         return dev->uclass_platdata;
 465 }
 466
 467 void *dev_get_priv(struct udevice *dev)
 468 {
 469         if (!dev) {
 470                 dm_warn("%s: null device\n", __func__);
 471                 return NULL;
 472         }
 473
 474         return dev->priv;
 475 }
 476
 477 void *dev_get_uclass_priv(struct udevice *dev)
 478 {
 479         if (!dev) {
 480                 dm_warn("%s: null device\n", __func__);
 481                 return NULL;
 482         }
 483
 484         return dev->uclass_priv;
 485 }
 486
 487 void *dev_get_parent_priv(struct udevice *dev)
 488 {
 489         if (!dev) {
 490                 dm_warn("%s: null device\n", __func__);
 491                 return NULL;
 492         }
 493
 494         return dev->parent_priv;
 495 }
 496
 497 static int device_get_device_tail(struct udevice *dev, int ret,
 498                                   struct udevice **devp)
 499 {
 500         if (ret)
 501                 return ret;
 502
 503         ret = device_probe(dev);
 504         if (ret)
 505                 return ret;
 506
 507         *devp = dev;
 508
 509         return 0;
 510 }
 511
 512 int device_get_child(struct udevice *parent, int index, struct udevice **devp)
 513 {
 514         struct udevice *dev;
 515
 516         list_for_each_entry(dev, &parent->child_head, sibling_node) {
 517                 if (!index--)
 518                         return device_get_device_tail(dev, 0, devp);
 519         }
 520
 521         return -ENODEV;
 522 }
 523
 524 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
 525                              bool find_req_seq, struct udevice **devp)
 526 {
 527         struct udevice *dev;
 528
 529         *devp = NULL;
 530         if (seq_or_req_seq == -1)
 531                 return -ENODEV;
 532
 533         list_for_each_entry(dev, &parent->child_head, sibling_node) {
 534                 if ((find_req_seq ? dev->req_seq : dev->seq) ==
 535                                 seq_or_req_seq) {
 536                         *devp = dev;
 537                         return 0;
 538                 }
 539         }
 540
 541         return -ENODEV;
 542 }
 543
 544 int device_get_child_by_seq(struct udevice *parent, int seq,
 545                             struct udevice **devp)
 546 {
 547         struct udevice *dev;
 548         int ret;
 549
 550         *devp = NULL;
 551         ret = device_find_child_by_seq(parent, seq, false, &dev);
 552         if (ret == -ENODEV) {
 553                 /*
 554                  * We didn't find it in probed devices. See if there is one
 555                  * that will request this seq if probed.
 556                  */
 557                 ret = device_find_child_by_seq(parent, seq, true, &dev);
 558         }
 559         return device_get_device_tail(dev, ret, devp);
 560 }
 561
 562 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
 563                                    struct udevice **devp)
 564 {
 565         struct udevice *dev;
 566
 567         *devp = NULL;
 568
 569         list_for_each_entry(dev, &parent->child_head, sibling_node) {
 570                 if (dev_of_offset(dev) == of_offset) {
 571                         *devp = dev;
 572                         return 0;
 573                 }
 574         }
 575
 576         return -ENODEV;
 577 }
 578
 579 int device_get_child_by_of_offset(struct udevice *parent, int node,
 580                                   struct udevice **devp)
 581 {
 582         struct udevice *dev;
 583         int ret;
 584
 585         *devp = NULL;
 586         ret = device_find_child_by_of_offset(parent, node, &dev);
 587         return device_get_device_tail(dev, ret, devp);
 588 }
 589
 590 static struct udevice *_device_find_global_by_of_offset(struct udevice *parent,
 591                                                         int of_offset)
 592 {
 593         struct udevice *dev, *found;
 594
 595         if (dev_of_offset(parent) == of_offset)
 596                 return parent;
 597
 598         list_for_each_entry(dev, &parent->child_head, sibling_node) {
 599                 found = _device_find_global_by_of_offset(dev, of_offset);
 600                 if (found)
 601                         return found;
 602         }
 603
 604         return NULL;
 605 }
 606
 607 int device_get_global_by_of_offset(int of_offset, struct udevice **devp)
 608 {
 609         struct udevice *dev;
 610
 611         dev = _device_find_global_by_of_offset(gd->dm_root, of_offset);
 612         return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
 613 }
 614
 615 int device_find_first_child(struct udevice *parent, struct udevice **devp)
 616 {
 617         if (list_empty(&parent->child_head)) {
 618                 *devp = NULL;
 619         } else {
 620                 *devp = list_first_entry(&parent->child_head, struct udevice,
 621                                          sibling_node);
 622         }
 623
 624         return 0;
 625 }
 626
 627 int device_find_next_child(struct udevice **devp)
 628 {
 629         struct udevice *dev = *devp;
 630         struct udevice *parent = dev->parent;
 631
 632         if (list_is_last(&dev->sibling_node, &parent->child_head)) {
 633                 *devp = NULL;
 634         } else {
 635                 *devp = list_entry(dev->sibling_node.next, struct udevice,
 636                                    sibling_node);
 637         }
 638
 639         return 0;
 640 }
 641
 642 struct udevice *dev_get_parent(struct udevice *child)
 643 {
 644         return child->parent;
 645 }
 646
 647 ulong dev_get_driver_data(struct udevice *dev)
 648 {
 649         return dev->driver_data;
 650 }
 651
 652 const void *dev_get_driver_ops(struct udevice *dev)
 653 {
 654         if (!dev || !dev->driver->ops)
 655                 return NULL;
 656
 657         return dev->driver->ops;
 658 }
 659
 660 enum uclass_id device_get_uclass_id(struct udevice *dev)
 661 {
 662         return dev->uclass->uc_drv->id;
 663 }
 664
 665 const char *dev_get_uclass_name(struct udevice *dev)
 666 {
 667         if (!dev)
 668                 return NULL;
 669
 670         return dev->uclass->uc_drv->name;
 671 }
 672
 673 bool device_has_children(struct udevice *dev)
 674 {
 675         return !list_empty(&dev->child_head);
 676 }
 677
 678 bool device_has_active_children(struct udevice *dev)
 679 {
 680         struct udevice *child;
 681
 682         for (device_find_first_child(dev, &child);
 683              child;
 684              device_find_next_child(&child)) {
 685                 if (device_active(child))
 686                         return true;
 687         }
 688
 689         return false;
 690 }
 691
 692 bool device_is_last_sibling(struct udevice *dev)
 693 {
 694         struct udevice *parent = dev->parent;
 695
 696         if (!parent)
 697                 return false;
 698         return list_is_last(&dev->sibling_node, &parent->child_head);
 699 }
 700
 701 void device_set_name_alloced(struct udevice *dev)
 702 {
 703         dev->flags |= DM_FLAG_NAME_ALLOCED;
 704 }
 705
 706 int device_set_name(struct udevice *dev, const char *name)
 707 {
 708         name = strdup(name);
 709         if (!name)
 710                 return -ENOMEM;
 711         dev->name = name;
 712         device_set_name_alloced(dev);
 713
 714         return 0;
 715 }
 716
 717 bool device_is_compatible(struct udevice *dev, const char *compat)
 718 {
 719         return ofnode_device_is_compatible(dev_ofnode(dev), compat);
 720 }
 721
 722 bool of_machine_is_compatible(const char *compat)
 723 {
 724         const void *fdt = gd->fdt_blob;
 725
 726         return !fdt_node_check_compatible(fdt, 0, compat);
 727 }