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