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/acpi.h>
  16 #include <dm/device.h>
  17 #include <dm/device-internal.h>
  18 #include <dm/lists.h>
  19 #include <dm/of.h>
  20 #include <dm/of_access.h>
  21 #include <dm/platdata.h>
  22 #include <dm/read.h>
  23 #include <dm/root.h>
  24 #include <dm/uclass.h>
  25 #include <dm/util.h>
  26 #include <linux/list.h>
  27
  28 DECLARE_GLOBAL_DATA_PTR;
  29
  30 static struct driver_info root_info = {
  31         .name           = "root_driver",
  32 };
  33
  34 struct udevice *dm_root(void)
  35 {
  36         if (!gd->dm_root) {
  37                 dm_warn("Virtual root driver does not exist!\n");
  38                 return NULL;
  39         }
  40
  41         return gd->dm_root;
  42 }
  43
  44 void dm_fixup_for_gd_move(struct global_data *new_gd)
  45 {
  46         /* The sentinel node has moved, so update things that point to it */
  47         if (gd->dm_root) {
  48                 new_gd->uclass_root.next->prev = &new_gd->uclass_root;
  49                 new_gd->uclass_root.prev->next = &new_gd->uclass_root;
  50         }
  51 }
  52
  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                                 ((ulong)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 int dm_init(bool of_live)
 132 {
 133         int ret;
 134
 135         if (gd->dm_root) {
 136                 dm_warn("Virtual root driver already exists!\n");
 137                 return -EINVAL;
 138         }
 139         INIT_LIST_HEAD(&DM_UCLASS_ROOT_NON_CONST);
 140
 141         if (IS_ENABLED(CONFIG_NEEDS_MANUAL_RELOC)) {
 142                 fix_drivers();
 143                 fix_uclass();
 144                 fix_devices();
 145         }
 146
 147         ret = device_bind_by_name(NULL, false, &root_info, &DM_ROOT_NON_CONST);
 148         if (ret)
 149                 return ret;
 150 #if CONFIG_IS_ENABLED(OF_CONTROL)
 151         if (CONFIG_IS_ENABLED(OF_LIVE) && of_live)
 152                 DM_ROOT_NON_CONST->node = np_to_ofnode(gd_of_root());
 153         else
 154                 DM_ROOT_NON_CONST->node = offset_to_ofnode(0);
 155 #endif
 156         ret = device_probe(DM_ROOT_NON_CONST);
 157         if (ret)
 158                 return ret;
 159
 160         return 0;
 161 }
 162
 163 int dm_uninit(void)
 164 {
 165         device_remove(dm_root(), DM_REMOVE_NORMAL);
 166         device_unbind(dm_root());
 167         gd->dm_root = NULL;
 168
 169         return 0;
 170 }
 171
 172 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 173 int dm_remove_devices_flags(uint flags)
 174 {
 175         device_remove(dm_root(), flags);
 176
 177         return 0;
 178 }
 179 #endif
 180
 181 int dm_scan_platdata(bool pre_reloc_only)
 182 {
 183         int ret;
 184
 185         if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
 186                 struct driver_rt *dyn;
 187                 int n_ents;
 188
 189                 n_ents = ll_entry_count(struct driver_info, driver_info);
 190                 dyn = calloc(n_ents, sizeof(struct driver_rt));
 191                 if (!dyn)
 192                         return -ENOMEM;
 193                 gd_set_dm_driver_rt(dyn);
 194         }
 195
 196         ret = lists_bind_drivers(DM_ROOT_NON_CONST, pre_reloc_only);
 197         if (ret == -ENOENT) {
 198                 dm_warn("Some drivers were not found\n");
 199                 ret = 0;
 200         }
 201
 202         return ret;
 203 }
 204
 205 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
 206 static int dm_scan_fdt_live(struct udevice *parent,
 207                             const struct device_node *node_parent,
 208                             bool pre_reloc_only)
 209 {
 210         struct device_node *np;
 211         int ret = 0, err;
 212
 213         for (np = node_parent->child; np; np = np->sibling) {
 214
 215                 if (!of_device_is_available(np)) {
 216                         pr_debug("   - ignoring disabled device\n");
 217                         continue;
 218                 }
 219                 err = lists_bind_fdt(parent, np_to_ofnode(np), NULL,
 220                                      pre_reloc_only);
 221                 if (err && !ret) {
 222                         ret = err;
 223                         debug("%s: ret=%d\n", np->name, ret);
 224                 }
 225         }
 226
 227         if (ret)
 228                 dm_warn("Some drivers failed to bind\n");
 229
 230         return ret;
 231 }
 232
 233 /**
 234  * dm_scan_fdt_node() - Scan the device tree and bind drivers for a node
 235  *
 236  * This scans the subnodes of a device tree node and and creates a driver
 237  * for each one.
 238  *
 239  * @parent: Parent device for the devices that will be created
 240  * @blob: Pointer to device tree blob
 241  * @offset: Offset of node to scan
 242  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
 243  * flag. If false bind all drivers.
 244  * @return 0 if OK, -ve on error
 245  */
 246 static int dm_scan_fdt_node(struct udevice *parent, const void *blob,
 247                             int offset, bool pre_reloc_only)
 248 {
 249         int ret = 0, err;
 250
 251         for (offset = fdt_first_subnode(blob, offset);
 252              offset > 0;
 253              offset = fdt_next_subnode(blob, offset)) {
 254                 const char *node_name = fdt_get_name(blob, offset, NULL);
 255
 256                 if (!fdtdec_get_is_enabled(blob, offset)) {
 257                         pr_debug("   - ignoring disabled device\n");
 258                         continue;
 259                 }
 260                 err = lists_bind_fdt(parent, offset_to_ofnode(offset), NULL,
 261                                      pre_reloc_only);
 262                 if (err && !ret) {
 263                         ret = err;
 264                         debug("%s: ret=%d\n", node_name, ret);
 265                 }
 266         }
 267
 268         if (ret)
 269                 dm_warn("Some drivers failed to bind\n");
 270
 271         return ret;
 272 }
 273
 274 int dm_scan_fdt_dev(struct udevice *dev)
 275 {
 276         if (!dev_of_valid(dev))
 277                 return 0;
 278
 279         if (of_live_active())
 280                 return dm_scan_fdt_live(dev, dev_np(dev),
 281                                 gd->flags & GD_FLG_RELOC ? false : true);
 282
 283         return dm_scan_fdt_node(dev, gd->fdt_blob, dev_of_offset(dev),
 284                                 gd->flags & GD_FLG_RELOC ? false : true);
 285 }
 286
 287 int dm_scan_fdt(const void *blob, bool pre_reloc_only)
 288 {
 289         if (of_live_active())
 290                 return dm_scan_fdt_live(gd->dm_root, gd_of_root(),
 291                                         pre_reloc_only);
 292
 293         return dm_scan_fdt_node(gd->dm_root, blob, 0, pre_reloc_only);
 294 }
 295
 296 static int dm_scan_fdt_ofnode_path(const void *blob, const char *path,
 297                                    bool pre_reloc_only)
 298 {
 299         ofnode node;
 300
 301         node = ofnode_path(path);
 302         if (!ofnode_valid(node))
 303                 return 0;
 304
 305         if (of_live_active())
 306                 return dm_scan_fdt_live(gd->dm_root, node.np, pre_reloc_only);
 307
 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
 353         ret = dm_init(CONFIG_IS_ENABLED(OF_LIVE));
 354         if (ret) {
 355                 debug("dm_init() failed: %d\n", ret);
 356                 return ret;
 357         }
 358         ret = dm_scan_platdata(pre_reloc_only);
 359         if (ret) {
 360                 debug("dm_scan_platdata() failed: %d\n", ret);
 361                 return ret;
 362         }
 363
 364         if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
 365                 ret = dm_extended_scan_fdt(gd->fdt_blob, pre_reloc_only);
 366                 if (ret) {
 367                         debug("dm_extended_scan_dt() failed: %d\n", ret);
 368                         return ret;
 369                 }
 370         }
 371
 372         ret = dm_scan_other(pre_reloc_only);
 373         if (ret)
 374                 return ret;
 375
 376         return 0;
 377 }
 378
 379 #ifdef CONFIG_ACPIGEN
 380 static int root_acpi_get_name(const struct udevice *dev, char *out_name)
 381 {
 382         return acpi_copy_name(out_name, "\\_SB");
 383 }
 384
 385 struct acpi_ops root_acpi_ops = {
 386         .get_name       = root_acpi_get_name,
 387 };
 388 #endif
 389
 390 /* This is the root driver - all drivers are children of this */
 391 U_BOOT_DRIVER(root_driver) = {
 392         .name   = "root_driver",
 393         .id     = UCLASS_ROOT,
 394         ACPI_OPS_PTR(&root_acpi_ops)
 395 };
 396
 397 /* This is the root uclass */
 398 UCLASS_DRIVER(root) = {
 399         .name   = "root",
 400         .id     = UCLASS_ROOT,
 401 };