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