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 <[email protected]>
   7  */
   8
   9 #define LOG_CATEGORY UCLASS_ROOT
  10
  11 #include <errno.h>
  12 #include <fdtdec.h>
  13 #include <log.h>
  14 #include <malloc.h>
  15 #include <asm-generic/sections.h>
  16 #include <asm/global_data.h>
  17 #include <linux/libfdt.h>
  18 #include <dm/acpi.h>
  19 #include <dm/device.h>
  20 #include <dm/device-internal.h>
  21 #include <dm/lists.h>
  22 #include <dm/of.h>
  23 #include <dm/of_access.h>
  24 #include <dm/platdata.h>
  25 #include <dm/read.h>
  26 #include <dm/root.h>
  27 #include <dm/uclass.h>
  28 #include <dm/uclass-internal.h>
  29 #include <dm/util.h>
  30 #include <linux/list.h>
  31 #include <linux/printk.h>
  32
  33 DECLARE_GLOBAL_DATA_PTR;
  34
  35 static struct driver_info root_info = {
  36         .name           = "root_driver",
  37 };
  38
  39 struct udevice *dm_root(void)
  40 {
  41         if (!gd->dm_root) {
  42                 dm_warn("Virtual root driver does not exist!\n");
  43                 return NULL;
  44         }
  45
  46         return gd->dm_root;
  47 }
  48
  49 void dm_fixup_for_gd_move(struct global_data *new_gd)
  50 {
  51         /* The sentinel node has moved, so update things that point to it */
  52         if (gd->dm_root) {
  53                 new_gd->uclass_root->next->prev = new_gd->uclass_root;
  54                 new_gd->uclass_root->prev->next = new_gd->uclass_root;
  55         }
  56 }
  57
  58 static int dm_setup_inst(void)
  59 {
  60         DM_ROOT_NON_CONST = DM_DEVICE_GET(root);
  61
  62         if (CONFIG_IS_ENABLED(OF_PLATDATA_RT)) {
  63                 struct udevice_rt *urt;
  64                 void *start, *end;
  65                 int each_size;
  66                 void *base;
  67                 int n_ents;
  68                 uint size;
  69
  70                 /* Allocate the udevice_rt table */
  71                 each_size = dm_udevice_size();
  72                 start = ll_entry_start(struct udevice, udevice);
  73                 end = ll_entry_end(struct udevice, udevice);
  74                 size = end - start;
  75                 n_ents = size / each_size;
  76                 urt = calloc(n_ents, sizeof(struct udevice_rt));
  77                 if (!urt)
  78                         return log_msg_ret("urt", -ENOMEM);
  79                 gd_set_dm_udevice_rt(urt);
  80
  81                 /* Now allocate space for the priv/plat data, and copy it in */
  82                 size = __priv_data_end - __priv_data_start;
  83
  84                 base = calloc(1, size);
  85                 if (!base)
  86                         return log_msg_ret("priv", -ENOMEM);
  87                 memcpy(base, __priv_data_start, size);
  88                 gd_set_dm_priv_base(base);
  89         }
  90
  91         return 0;
  92 }
  93
  94 int dm_init(bool of_live)
  95 {
  96         int ret;
  97
  98         if (gd->dm_root) {
  99                 dm_warn("Virtual root driver already exists!\n");
 100                 return -EINVAL;
 101         }
 102         if (CONFIG_IS_ENABLED(OF_PLATDATA_INST)) {
 103                 gd->uclass_root = &uclass_head;
 104         } else {
 105                 gd->uclass_root = &DM_UCLASS_ROOT_S_NON_CONST;
 106                 INIT_LIST_HEAD(DM_UCLASS_ROOT_NON_CONST);
 107         }
 108
 109         if (CONFIG_IS_ENABLED(OF_PLATDATA_INST)) {
 110                 ret = dm_setup_inst();
 111                 if (ret) {
 112                         log_debug("dm_setup_inst() failed: %d\n", ret);
 113                         return ret;
 114                 }
 115         } else {
 116                 ret = device_bind_by_name(NULL, false, &root_info,
 117                                           &DM_ROOT_NON_CONST);
 118                 if (ret)
 119                         return ret;
 120                 if (CONFIG_IS_ENABLED(OF_CONTROL))
 121                         dev_set_ofnode(DM_ROOT_NON_CONST, ofnode_root());
 122                 ret = device_probe(DM_ROOT_NON_CONST);
 123                 if (ret)
 124                         return ret;
 125         }
 126
 127         INIT_LIST_HEAD((struct list_head *)&gd->dmtag_list);
 128
 129         return 0;
 130 }
 131
 132 int dm_uninit(void)
 133 {
 134         /* Remove non-vital devices first */
 135         device_remove(dm_root(), DM_REMOVE_NON_VITAL);
 136         device_remove(dm_root(), DM_REMOVE_NORMAL);
 137         device_unbind(dm_root());
 138         gd->dm_root = NULL;
 139
 140         return 0;
 141 }
 142
 143 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 144 int dm_remove_devices_flags(uint flags)
 145 {
 146         device_remove(dm_root(), flags);
 147
 148         return 0;
 149 }
 150 #endif
 151
 152 int dm_scan_plat(bool pre_reloc_only)
 153 {
 154         int ret;
 155
 156         if (CONFIG_IS_ENABLED(OF_PLATDATA_DRIVER_RT)) {
 157                 struct driver_rt *dyn;
 158                 int n_ents;
 159
 160                 n_ents = ll_entry_count(struct driver_info, driver_info);
 161                 dyn = calloc(n_ents, sizeof(struct driver_rt));
 162                 if (!dyn)
 163                         return -ENOMEM;
 164                 gd_set_dm_driver_rt(dyn);
 165         }
 166
 167         ret = lists_bind_drivers(DM_ROOT_NON_CONST, pre_reloc_only);
 168         if (ret == -ENOENT) {
 169                 dm_warn("Some drivers were not found\n");
 170                 ret = 0;
 171         }
 172
 173         return ret;
 174 }
 175
 176 #if CONFIG_IS_ENABLED(OF_REAL)
 177 /**
 178  * dm_scan_fdt_node() - Scan the device tree and bind drivers for a node
 179  *
 180  * This scans the subnodes of a device tree node and and creates a driver
 181  * for each one.
 182  *
 183  * @parent: Parent device for the devices that will be created
 184  * @node: Node to scan
 185  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
 186  * flag. If false bind all drivers.
 187  * Return: 0 if OK, -ve on error
 188  */
 189 static int dm_scan_fdt_node(struct udevice *parent, ofnode parent_node,
 190                             bool pre_reloc_only)
 191 {
 192         int ret = 0, err = 0;
 193         ofnode node;
 194
 195         if (!ofnode_valid(parent_node))
 196                 return 0;
 197
 198         for (node = ofnode_first_subnode(parent_node);
 199              ofnode_valid(node);
 200              node = ofnode_next_subnode(node)) {
 201                 const char *node_name = ofnode_get_name(node);
 202
 203                 if (!ofnode_is_enabled(node)) {
 204                         pr_debug("   - ignoring disabled device\n");
 205                         continue;
 206                 }
 207                 err = lists_bind_fdt(parent, node, NULL, NULL, pre_reloc_only);
 208                 if (err && !ret) {
 209                         ret = err;
 210                         dm_warn("%s: ret=%d\n", node_name, ret);
 211                 }
 212         }
 213
 214         if (ret)
 215                 dm_warn("Some drivers failed to bind\n");
 216
 217         return ret;
 218 }
 219
 220 int dm_scan_fdt_dev(struct udevice *dev)
 221 {
 222         return dm_scan_fdt_node(dev, dev_ofnode(dev),
 223                                 gd->flags & GD_FLG_RELOC ? false : true);
 224 }
 225
 226 int dm_scan_fdt(bool pre_reloc_only)
 227 {
 228         return dm_scan_fdt_node(gd->dm_root, ofnode_root(), pre_reloc_only);
 229 }
 230
 231 static int dm_scan_fdt_ofnode_path(const char *path, bool pre_reloc_only)
 232 {
 233         ofnode node;
 234
 235         node = ofnode_path(path);
 236
 237         return dm_scan_fdt_node(gd->dm_root, node, pre_reloc_only);
 238 }
 239
 240 int dm_extended_scan(bool pre_reloc_only)
 241 {
 242         int ret, i;
 243         const char * const nodes[] = {
 244                 "/chosen",
 245                 "/clocks",
 246                 "/firmware",
 247                 "/reserved-memory",
 248         };
 249
 250         ret = dm_scan_fdt(pre_reloc_only);
 251         if (ret) {
 252                 dm_warn("dm_scan_fdt() failed: %d\n", ret);
 253                 return ret;
 254         }
 255
 256         /* Some nodes aren't devices themselves but may contain some */
 257         for (i = 0; i < ARRAY_SIZE(nodes); i++) {
 258                 ret = dm_scan_fdt_ofnode_path(nodes[i], pre_reloc_only);
 259                 if (ret) {
 260                         dm_warn("dm_scan_fdt() scan for %s failed: %d\n",
 261                                 nodes[i], ret);
 262                         return ret;
 263                 }
 264         }
 265
 266         return ret;
 267 }
 268 #endif
 269
 270 __weak int dm_scan_other(bool pre_reloc_only)
 271 {
 272         return 0;
 273 }
 274
 275 #if CONFIG_IS_ENABLED(OF_PLATDATA_INST) && CONFIG_IS_ENABLED(READ_ONLY)
 276 void *dm_priv_to_rw(void *priv)
 277 {
 278         long offset = priv - (void *)__priv_data_start;
 279
 280         return gd_dm_priv_base() + offset;
 281 }
 282 #endif
 283
 284 static int dm_probe_devices(struct udevice *dev, bool pre_reloc_only)
 285 {
 286         ofnode node = dev_ofnode(dev);
 287         struct udevice *child;
 288         int ret;
 289
 290         if (pre_reloc_only &&
 291             (!ofnode_valid(node) || !ofnode_pre_reloc(node)) &&
 292             !(dev->driver->flags & DM_FLAG_PRE_RELOC))
 293                 goto probe_children;
 294
 295         if (dev_get_flags(dev) & DM_FLAG_PROBE_AFTER_BIND) {
 296                 ret = device_probe(dev);
 297                 if (ret)
 298                         return ret;
 299         }
 300
 301 probe_children:
 302         list_for_each_entry(child, &dev->child_head, sibling_node)
 303                 dm_probe_devices(child, pre_reloc_only);
 304
 305         return 0;
 306 }
 307
 308 /**
 309  * dm_scan() - Scan tables to bind devices
 310  *
 311  * Runs through the driver_info tables and binds the devices it finds. Then runs
 312  * through the devicetree nodes. Finally calls dm_scan_other() to add any
 313  * special devices
 314  *
 315  * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
 316  * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
 317  */
 318 static int dm_scan(bool pre_reloc_only)
 319 {
 320         int ret;
 321
 322         ret = dm_scan_plat(pre_reloc_only);
 323         if (ret) {
 324                 dm_warn("dm_scan_plat() failed: %d\n", ret);
 325                 return ret;
 326         }
 327
 328         if (CONFIG_IS_ENABLED(OF_REAL)) {
 329                 ret = dm_extended_scan(pre_reloc_only);
 330                 if (ret) {
 331                         dm_warn("dm_extended_scan() failed: %d\n", ret);
 332                         return ret;
 333                 }
 334         }
 335
 336         ret = dm_scan_other(pre_reloc_only);
 337         if (ret)
 338                 return ret;
 339
 340         return dm_probe_devices(gd->dm_root, pre_reloc_only);
 341 }
 342
 343 int dm_init_and_scan(bool pre_reloc_only)
 344 {
 345         int ret;
 346
 347         ret = dm_init(CONFIG_IS_ENABLED(OF_LIVE));
 348         if (ret) {
 349                 dm_warn("dm_init() failed: %d\n", ret);
 350                 return ret;
 351         }
 352         if (!CONFIG_IS_ENABLED(OF_PLATDATA_INST)) {
 353                 ret = dm_scan(pre_reloc_only);
 354                 if (ret) {
 355                         log_debug("dm_scan() failed: %d\n", ret);
 356                         return ret;
 357                 }
 358         }
 359         if (CONFIG_IS_ENABLED(DM_EVENT)) {
 360                 ret = event_notify_null(gd->flags & GD_FLG_RELOC ?
 361                                         EVT_DM_POST_INIT_R :
 362                                         EVT_DM_POST_INIT_F);
 363                 if (ret)
 364                         return log_msg_ret("ev", ret);
 365         }
 366
 367         return 0;
 368 }
 369
 370 void dm_get_stats(int *device_countp, int *uclass_countp)
 371 {
 372         *device_countp = device_get_decendent_count(gd->dm_root);
 373         *uclass_countp = uclass_get_count();
 374 }
 375
 376 void dev_collect_stats(struct dm_stats *stats, const struct udevice *parent)
 377 {
 378         const struct udevice *dev;
 379         int i;
 380
 381         stats->dev_count++;
 382         stats->dev_size += sizeof(struct udevice);
 383         stats->dev_name_size += strlen(parent->name) + 1;
 384         for (i = 0; i < DM_TAG_ATTACH_COUNT; i++) {
 385                 int size = dev_get_attach_size(parent, i);
 386
 387                 if (size ||
 388                     (i == DM_TAG_DRIVER_DATA && parent->driver_data)) {
 389                         stats->attach_count[i]++;
 390                         stats->attach_size[i] += size;
 391                         stats->attach_count_total++;
 392                         stats->attach_size_total += size;
 393                 }
 394         }
 395
 396         list_for_each_entry(dev, &parent->child_head, sibling_node)
 397                 dev_collect_stats(stats, dev);
 398 }
 399
 400 void uclass_collect_stats(struct dm_stats *stats)
 401 {
 402         struct uclass *uc;
 403
 404         list_for_each_entry(uc, gd->uclass_root, sibling_node) {
 405                 int size;
 406
 407                 stats->uc_count++;
 408                 stats->uc_size += sizeof(struct uclass);
 409                 size = uc->uc_drv->priv_auto;
 410                 if (size) {
 411                         stats->uc_attach_count++;
 412                         stats->uc_attach_size += size;
 413                 }
 414         }
 415 }
 416
 417 void dm_get_mem(struct dm_stats *stats)
 418 {
 419         memset(stats, '\0', sizeof(*stats));
 420         dev_collect_stats(stats, gd->dm_root);
 421         uclass_collect_stats(stats);
 422         dev_tag_collect_stats(stats);
 423
 424         stats->total_size = stats->dev_size + stats->uc_size +
 425                 stats->attach_size_total + stats->uc_attach_size +
 426                 stats->tag_size;
 427 }
 428
 429 #if CONFIG_IS_ENABLED(ACPIGEN)
 430 static int root_acpi_get_name(const struct udevice *dev, char *out_name)
 431 {
 432         return acpi_copy_name(out_name, "\\_SB");
 433 }
 434
 435 struct acpi_ops root_acpi_ops = {
 436         .get_name       = root_acpi_get_name,
 437 };
 438 #endif
 439
 440 /* This is the root driver - all drivers are children of this */
 441 U_BOOT_DRIVER(root_driver) = {
 442         .name   = "root_driver",
 443         .id     = UCLASS_ROOT,
 444         ACPI_OPS_PTR(&root_acpi_ops)
 445 };
 446
 447 /* This is the root uclass */
 448 UCLASS_DRIVER(root) = {
 449         .name   = "root",
 450         .id     = UCLASS_ROOT,
 451 };