drivers/core/device.c

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