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