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