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