drivers/core/root.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2013 Google, Inc
   4  *
   5  * (C) Copyright 2012
   6  * Pavel Herrmann <morpheus.ibis@gmail.com>
   7  */
   8
   9 #include <common.h>
  10 #include <errno.h>
  11 #include <fdtdec.h>
  12 #include <malloc.h>
  13 #include <linux/libfdt.h>
  14 #include <dm/device.h>
  15 #include <dm/device-internal.h>
  16 #include <dm/lists.h>
  17 #include <dm/of.h>
  18 #include <dm/of_access.h>
  19 #include <dm/platdata.h>
  20 #include <dm/read.h>
  21 #include <dm/root.h>
  22 #include <dm/uclass.h>
  23 #include <dm/util.h>
  24 #include <linux/list.h>
  25
  26 DECLARE_GLOBAL_DATA_PTR;
  27
  28 struct root_priv {
  29         fdt_addr_t translation_offset;  /* optional translation offset */
  30 };
  31
  32 static const struct driver_info root_info = {
  33         .name           = "root_driver",
  34 };
  35
  36 struct udevice *dm_root(void)
  37 {
  38         if (!gd->dm_root) {
  39                 dm_warn("Virtual root driver does not exist!\n");
  40                 return NULL;
  41         }
  42
  43         return gd->dm_root;
  44 }
  45
  46 void dm_fixup_for_gd_move(struct global_data *new_gd)
  47 {
  48         /* The sentinel node has moved, so update things that point to it */
  49         if (gd->dm_root) {
  50                 new_gd->uclass_root.next->prev = &new_gd->uclass_root;
  51                 new_gd->uclass_root.prev->next = &new_gd->uclass_root;
  52         }
  53 }
  54
  55 fdt_addr_t dm_get_translation_offset(void)
  56 {
  57         struct udevice *root = dm_root();
  58         struct root_priv *priv = dev_get_priv(root);
  59
  60         return priv->translation_offset;
  61 }
  62
  63 void dm_set_translation_offset(fdt_addr_t offs)
  64 {
  65         struct udevice *root = dm_root();
  66         struct root_priv *priv = dev_get_priv(root);
  67
  68         priv->translation_offset = offs;
  69 }
  70
  71 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
  72 void fix_drivers(void)
  73 {
  74         struct driver *drv =
  75                 ll_entry_start(struct driver, driver);
  76         const int n_ents = ll_entry_count(struct driver, driver);
  77         struct driver *entry;
  78
  79         for (entry = drv; entry != drv + n_ents; entry++) {
  80                 if (entry->of_match)
  81                         entry->of_match = (const struct udevice_id *)
  82                                 ((u32)entry->of_match + gd->reloc_off);
  83                 if (entry->bind)
  84                         entry->bind += gd->reloc_off;
  85                 if (entry->probe)
  86                         entry->probe += gd->reloc_off;
  87                 if (entry->remove)
  88                         entry->remove += gd->reloc_off;
  89                 if (entry->unbind)
  90                         entry->unbind += gd->reloc_off;
  91                 if (entry->ofdata_to_platdata)
  92                         entry->ofdata_to_platdata += gd->reloc_off;
  93                 if (entry->child_post_bind)
  94                         entry->child_post_bind += gd->reloc_off;
  95                 if (entry->child_pre_probe)
  96                         entry->child_pre_probe += gd->reloc_off;
  97                 if (entry->child_post_remove)
  98                         entry->child_post_remove += gd->reloc_off;
  99                 /* OPS are fixed in every uclass post_probe function */
 100                 if (entry->ops)
 101                         entry->ops += gd->reloc_off;
 102         }
 103 }
 104
 105 void fix_uclass(void)
 106 {
 107         struct uclass_driver *uclass =
 108                 ll_entry_start(struct uclass_driver, uclass);
 109         const int n_ents = ll_entry_count(struct uclass_driver, uclass);
 110         struct uclass_driver *entry;
 111
 112         for (entry = uclass; entry != uclass + n_ents; entry++) {
 113                 if (entry->post_bind)
 114                         entry->post_bind += gd->reloc_off;
 115                 if (entry->pre_unbind)
 116                         entry->pre_unbind += gd->reloc_off;
 117                 if (entry->pre_probe)
 118                         entry->pre_probe += gd->reloc_off;
 119                 if (entry->post_probe)
 120                         entry->post_probe += gd->reloc_off;
 121                 if (entry->pre_remove)
 122                         entry->pre_remove += gd->reloc_off;
 123                 if (entry->child_post_bind)
 124                         entry->child_post_bind += gd->reloc_off;
 125                 if (entry->child_pre_probe)
 126                         entry->child_pre_probe += gd->reloc_off;
 127                 if (entry->init)
 128                         entry->init += gd->reloc_off;
 129                 if (entry->destroy)
 130                         entry->destroy += gd->reloc_off;
 131                 /* FIXME maybe also need to fix these ops */
 132                 if (entry->ops)
 133                         entry->ops += gd->reloc_off;
 134         }
 135 }
 136
 137 void fix_devices(void)
 138 {
 139         struct driver_info *dev =
 140                 ll_entry_start(struct driver_info, driver_info);
 141         const int n_ents = ll_entry_count(struct driver_info, driver_info);
 142         struct driver_info *entry;
 143
 144         for (entry = dev; entry != dev + n_ents; entry++) {
 145                 if (entry->platdata)
 146                         entry->platdata += gd->reloc_off;
 147         }
 148 }
 149
 150 #endif
 151
 152 int dm_init(bool of_live)
 153 {
 154         int ret;
 155
 156         if (gd->dm_root) {
 157                 dm_warn("Virtual root driver already exists!\n");
 158                 return -EINVAL;
 159         }
 160         INIT_LIST_HEAD(&DM_UCLASS_ROOT_NON_CONST);
 161
 162 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 163         fix_drivers();
 164         fix_uclass();
 165         fix_devices();
 166 #endif
 167
 168         ret = device_bind_by_name(NULL, false, &root_info, &DM_ROOT_NON_CONST);
 169         if (ret)
 170                 return ret;
 171 #if CONFIG_IS_ENABLED(OF_CONTROL)
 172 # if CONFIG_IS_ENABLED(OF_LIVE)
 173         if (of_live)
 174                 DM_ROOT_NON_CONST->node = np_to_ofnode(gd->of_root);
 175         else
 176 #endif
 177                 DM_ROOT_NON_CONST->node = offset_to_ofnode(0);
 178 #endif
 179         ret = device_probe(DM_ROOT_NON_CONST);
 180         if (ret)
 181                 return ret;
 182
 183         return 0;
 184 }
 185
 186 int dm_uninit(void)
 187 {
 188         device_remove(dm_root(), DM_REMOVE_NORMAL);
 189         device_unbind(dm_root());
 190         gd->dm_root = NULL;
 191
 192         return 0;
 193 }
 194
 195 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 196 int dm_remove_devices_flags(uint flags)
 197 {
 198         device_remove(dm_root(), flags);
 199
 200         return 0;
 201 }
 202 #endif
 203
 204 int dm_scan_platdata(bool pre_reloc_only)
 205 {
 206         int ret;
 207
 208         ret = lists_bind_drivers(DM_ROOT_NON_CONST, pre_reloc_only);
 209         if (ret == -ENOENT) {
 210                 dm_warn("Some drivers were not found\n");
 211                 ret = 0;
 212         }
 213
 214         return ret;
 215 }
 216
 217 #if CONFIG_IS_ENABLED(OF_LIVE)
 218 static int dm_scan_fdt_live(struct udevice *parent,
 219                             const struct device_node *node_parent,
 220                             bool pre_reloc_only)
 221 {
 222         struct device_node *np;
 223         int ret = 0, err;
 224
 225         for (np = node_parent->child; np; np = np->sibling) {
 226                 /* "chosen" node isn't a device itself but may contain some: */
 227                 if (!strcmp(np->name, "chosen")) {
 228                         pr_debug("parsing subnodes of \"chosen\"\n");
 229
 230                         err = dm_scan_fdt_live(parent, np, pre_reloc_only);
 231                         if (err && !ret)
 232                                 ret = err;
 233                         continue;
 234                 }
 235
 236                 if (!of_device_is_available(np)) {
 237                         pr_debug("   - ignoring disabled device\n");
 238                         continue;
 239                 }
 240                 err = lists_bind_fdt(parent, np_to_ofnode(np), NULL,
 241                                      pre_reloc_only);
 242                 if (err && !ret) {
 243                         ret = err;
 244                         debug("%s: ret=%d\n", np->name, ret);
 245                 }
 246         }
 247
 248         if (ret)
 249                 dm_warn("Some drivers failed to bind\n");
 250
 251         return ret;
 252 }
 253 #endif /* CONFIG_IS_ENABLED(OF_LIVE) */
 254
 255 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
 256 /**
 257  * dm_scan_fdt_node() - Scan the device tree and bind drivers for a node
 258  *
 259  * This scans the subnodes of a device tree node and and creates a driver
 260  * for each one.
 261  *
 262  * @parent: Parent device for the devices that will be created
 263  * @blob: Pointer to device tree blob
 264  * @offset: Offset of node to scan
 265  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
 266  * flag. If false bind all drivers.
 267  * @return 0 if OK, -ve on error
 268  */
 269 static int dm_scan_fdt_node(struct udevice *parent, const void *blob,
 270                             int offset, bool pre_reloc_only)
 271 {
 272         int ret = 0, err;
 273
 274         for (offset = fdt_first_subnode(blob, offset);
 275              offset > 0;
 276              offset = fdt_next_subnode(blob, offset)) {
 277                 const char *node_name = fdt_get_name(blob, offset, NULL);
 278
 279                 /*
 280                  * The "chosen" and "firmware" nodes aren't devices
 281                  * themselves but may contain some:
 282                  */
 283                 if (!strcmp(node_name, "chosen") ||
 284                     !strcmp(node_name, "firmware")) {
 285                         pr_debug("parsing subnodes of \"%s\"\n", node_name);
 286
 287                         err = dm_scan_fdt_node(parent, blob, offset,
 288                                                pre_reloc_only);
 289                         if (err && !ret)
 290                                 ret = err;
 291                         continue;
 292                 }
 293
 294                 if (!fdtdec_get_is_enabled(blob, offset)) {
 295                         pr_debug("   - ignoring disabled device\n");
 296                         continue;
 297                 }
 298                 err = lists_bind_fdt(parent, offset_to_ofnode(offset), NULL,
 299                                      pre_reloc_only);
 300                 if (err && !ret) {
 301                         ret = err;
 302                         debug("%s: ret=%d\n", node_name, ret);
 303                 }
 304         }
 305
 306         if (ret)
 307                 dm_warn("Some drivers failed to bind\n");
 308
 309         return ret;
 310 }
 311
 312 int dm_scan_fdt_dev(struct udevice *dev)
 313 {
 314         if (!dev_of_valid(dev))
 315                 return 0;
 316
 317 #if CONFIG_IS_ENABLED(OF_LIVE)
 318         if (of_live_active())
 319                 return dm_scan_fdt_live(dev, dev_np(dev),
 320                                 gd->flags & GD_FLG_RELOC ? false : true);
 321         else
 322 #endif
 323         return dm_scan_fdt_node(dev, gd->fdt_blob, dev_of_offset(dev),
 324                                 gd->flags & GD_FLG_RELOC ? false : true);
 325 }
 326
 327 int dm_scan_fdt(const void *blob, bool pre_reloc_only)
 328 {
 329 #if CONFIG_IS_ENABLED(OF_LIVE)
 330         if (of_live_active())
 331                 return dm_scan_fdt_live(gd->dm_root, gd->of_root,
 332                                         pre_reloc_only);
 333         else
 334 #endif
 335         return dm_scan_fdt_node(gd->dm_root, blob, 0, pre_reloc_only);
 336 }
 337 #else
 338 static int dm_scan_fdt_node(struct udevice *parent, const void *blob,
 339                             int offset, bool pre_reloc_only)
 340 {
 341         return 0;
 342 }
 343 #endif
 344
 345 static int dm_scan_fdt_ofnode_path(const char *path, bool pre_reloc_only)
 346 {
 347         ofnode node;
 348
 349         node = ofnode_path(path);
 350         if (!ofnode_valid(node))
 351                 return 0;
 352
 353 #if CONFIG_IS_ENABLED(OF_LIVE)
 354         if (of_live_active())
 355                 return dm_scan_fdt_live(gd->dm_root, node.np, pre_reloc_only);
 356 #endif
 357         return dm_scan_fdt_node(gd->dm_root, gd->fdt_blob, node.of_offset,
 358                                 pre_reloc_only);
 359 }
 360
 361 int dm_extended_scan_fdt(const void *blob, bool pre_reloc_only)
 362 {
 363         int ret;
 364
 365         ret = dm_scan_fdt(gd->fdt_blob, pre_reloc_only);
 366         if (ret) {
 367                 debug("dm_scan_fdt() failed: %d\n", ret);
 368                 return ret;
 369         }
 370
 371         ret = dm_scan_fdt_ofnode_path("/clocks", pre_reloc_only);
 372         if (ret) {
 373                 debug("scan for /clocks failed: %d\n", ret);
 374                 return ret;
 375         }
 376
 377         ret = dm_scan_fdt_ofnode_path("/firmware", pre_reloc_only);
 378         if (ret)
 379                 debug("scan for /firmware failed: %d\n", ret);
 380
 381         return ret;
 382 }
 383
 384 __weak int dm_scan_other(bool pre_reloc_only)
 385 {
 386         return 0;
 387 }
 388
 389 int dm_init_and_scan(bool pre_reloc_only)
 390 {
 391         int ret;
 392
 393         ret = dm_init(IS_ENABLED(CONFIG_OF_LIVE));
 394         if (ret) {
 395                 debug("dm_init() failed: %d\n", ret);
 396                 return ret;
 397         }
 398         ret = dm_scan_platdata(pre_reloc_only);
 399         if (ret) {
 400                 debug("dm_scan_platdata() failed: %d\n", ret);
 401                 return ret;
 402         }
 403
 404         if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
 405                 ret = dm_extended_scan_fdt(gd->fdt_blob, pre_reloc_only);
 406                 if (ret) {
 407                         debug("dm_extended_scan_dt() failed: %d\n", ret);
 408                         return ret;
 409                 }
 410         }
 411
 412         ret = dm_scan_other(pre_reloc_only);
 413         if (ret)
 414                 return ret;
 415
 416         return 0;
 417 }
 418
 419 /* This is the root driver - all drivers are children of this */
 420 U_BOOT_DRIVER(root_driver) = {
 421         .name   = "root_driver",
 422         .id     = UCLASS_ROOT,
 423         .priv_auto_alloc_size = sizeof(struct root_priv),
 424 };
 425
 426 /* This is the root uclass */
 427 UCLASS_DRIVER(root) = {
 428         .name   = "root",
 429         .id     = UCLASS_ROOT,
 430 };