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
 151 void dm_remove_devices_active(void)
 152 {
 153         /* Remove non-vital devices first */
 154         device_remove(dm_root(), DM_REMOVE_ACTIVE_ALL | DM_REMOVE_NON_VITAL);
 155         device_remove(dm_root(), DM_REMOVE_ACTIVE_ALL);
 156 }
 157 #endif
 158
 159 int dm_scan_plat(bool pre_reloc_only)
 160 {
 161         int ret;
 162
 163         if (CONFIG_IS_ENABLED(OF_PLATDATA_DRIVER_RT)) {
 164                 struct driver_rt *dyn;
 165                 int n_ents;
 166
 167                 n_ents = ll_entry_count(struct driver_info, driver_info);
 168                 dyn = calloc(n_ents, sizeof(struct driver_rt));
 169                 if (!dyn)
 170                         return -ENOMEM;
 171                 gd_set_dm_driver_rt(dyn);
 172         }
 173
 174         ret = lists_bind_drivers(DM_ROOT_NON_CONST, pre_reloc_only);
 175         if (ret == -ENOENT) {
 176                 dm_warn("Some drivers were not found\n");
 177                 ret = 0;
 178         }
 179
 180         return ret;
 181 }
 182
 183 #if CONFIG_IS_ENABLED(OF_REAL)
 184 /**
 185  * dm_scan_fdt_node() - Scan the device tree and bind drivers for a node
 186  *
 187  * This scans the subnodes of a device tree node and and creates a driver
 188  * for each one.
 189  *
 190  * @parent: Parent device for the devices that will be created
 191  * @node: Node to scan
 192  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
 193  * flag. If false bind all drivers.
 194  * Return: 0 if OK, -ve on error
 195  */
 196 static int dm_scan_fdt_node(struct udevice *parent, ofnode parent_node,
 197                             bool pre_reloc_only)
 198 {
 199         int ret = 0, err = 0;
 200         ofnode node;
 201
 202         if (!ofnode_valid(parent_node))
 203                 return 0;
 204
 205         for (node = ofnode_first_subnode(parent_node);
 206              ofnode_valid(node);
 207              node = ofnode_next_subnode(node)) {
 208                 const char *node_name = ofnode_get_name(node);
 209
 210                 if (!ofnode_is_enabled(node)) {
 211                         pr_debug("   - ignoring disabled device\n");
 212                         continue;
 213                 }
 214                 err = lists_bind_fdt(parent, node, NULL, NULL, pre_reloc_only);
 215                 if (err && !ret) {
 216                         ret = err;
 217                         dm_warn("%s: ret=%d\n", node_name, ret);
 218                 }
 219         }
 220
 221         if (ret)
 222                 dm_warn("Some drivers failed to bind\n");
 223
 224         return ret;
 225 }
 226
 227 int dm_scan_fdt_dev(struct udevice *dev)
 228 {
 229         return dm_scan_fdt_node(dev, dev_ofnode(dev),
 230                                 gd->flags & GD_FLG_RELOC ? false : true);
 231 }
 232
 233 int dm_scan_fdt(bool pre_reloc_only)
 234 {
 235         return dm_scan_fdt_node(gd->dm_root, ofnode_root(), pre_reloc_only);
 236 }
 237
 238 static int dm_scan_fdt_ofnode_path(const char *path, bool pre_reloc_only)
 239 {
 240         ofnode node;
 241
 242         node = ofnode_path(path);
 243
 244         return dm_scan_fdt_node(gd->dm_root, node, pre_reloc_only);
 245 }
 246
 247 int dm_extended_scan(bool pre_reloc_only)
 248 {
 249         int ret, i;
 250         const char * const nodes[] = {
 251                 "/chosen",
 252                 "/clocks",
 253                 "/firmware",
 254                 "/reserved-memory",
 255         };
 256
 257         ret = dm_scan_fdt(pre_reloc_only);
 258         if (ret) {
 259                 dm_warn("dm_scan_fdt() failed: %d\n", ret);
 260                 return ret;
 261         }
 262
 263         /* Some nodes aren't devices themselves but may contain some */
 264         for (i = 0; i < ARRAY_SIZE(nodes); i++) {
 265                 ret = dm_scan_fdt_ofnode_path(nodes[i], pre_reloc_only);
 266                 if (ret) {
 267                         dm_warn("dm_scan_fdt() scan for %s failed: %d\n",
 268                                 nodes[i], ret);
 269                         return ret;
 270                 }
 271         }
 272
 273         return ret;
 274 }
 275 #endif
 276
 277 __weak int dm_scan_other(bool pre_reloc_only)
 278 {
 279         return 0;
 280 }
 281
 282 #if CONFIG_IS_ENABLED(OF_PLATDATA_INST) && CONFIG_IS_ENABLED(READ_ONLY)
 283 void *dm_priv_to_rw(void *priv)
 284 {
 285         long offset = priv - (void *)__priv_data_start;
 286
 287         return gd_dm_priv_base() + offset;
 288 }
 289 #endif
 290
 291 static int dm_probe_devices(struct udevice *dev, bool pre_reloc_only)
 292 {
 293         ofnode node = dev_ofnode(dev);
 294         struct udevice *child;
 295         int ret;
 296
 297         if (pre_reloc_only &&
 298             (!ofnode_valid(node) || !ofnode_pre_reloc(node)) &&
 299             !(dev->driver->flags & DM_FLAG_PRE_RELOC))
 300                 goto probe_children;
 301
 302         if (dev_get_flags(dev) & DM_FLAG_PROBE_AFTER_BIND) {
 303                 ret = device_probe(dev);
 304                 if (ret)
 305                         return ret;
 306         }
 307
 308 probe_children:
 309         list_for_each_entry(child, &dev->child_head, sibling_node)
 310                 dm_probe_devices(child, pre_reloc_only);
 311
 312         return 0;
 313 }
 314
 315 /**
 316  * dm_scan() - Scan tables to bind devices
 317  *
 318  * Runs through the driver_info tables and binds the devices it finds. Then runs
 319  * through the devicetree nodes. Finally calls dm_scan_other() to add any
 320  * special devices
 321  *
 322  * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
 323  * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
 324  */
 325 static int dm_scan(bool pre_reloc_only)
 326 {
 327         int ret;
 328
 329         ret = dm_scan_plat(pre_reloc_only);
 330         if (ret) {
 331                 dm_warn("dm_scan_plat() failed: %d\n", ret);
 332                 return ret;
 333         }
 334
 335         if (CONFIG_IS_ENABLED(OF_REAL)) {
 336                 ret = dm_extended_scan(pre_reloc_only);
 337                 if (ret) {
 338                         dm_warn("dm_extended_scan() failed: %d\n", ret);
 339                         return ret;
 340                 }
 341         }
 342
 343         ret = dm_scan_other(pre_reloc_only);
 344         if (ret)
 345                 return ret;
 346
 347         return dm_probe_devices(gd->dm_root, pre_reloc_only);
 348 }
 349
 350 int dm_init_and_scan(bool pre_reloc_only)
 351 {
 352         int ret;
 353
 354         ret = dm_init(CONFIG_IS_ENABLED(OF_LIVE));
 355         if (ret) {
 356                 dm_warn("dm_init() failed: %d\n", ret);
 357                 return ret;
 358         }
 359         if (!CONFIG_IS_ENABLED(OF_PLATDATA_INST)) {
 360                 ret = dm_scan(pre_reloc_only);
 361                 if (ret) {
 362                         log_debug("dm_scan() failed: %d\n", ret);
 363                         return ret;
 364                 }
 365         }
 366         if (CONFIG_IS_ENABLED(DM_EVENT)) {
 367                 ret = event_notify_null(gd->flags & GD_FLG_RELOC ?
 368                                         EVT_DM_POST_INIT_R :
 369                                         EVT_DM_POST_INIT_F);
 370                 if (ret)
 371                         return log_msg_ret("ev", ret);
 372         }
 373
 374         return 0;
 375 }
 376
 377 void dm_get_stats(int *device_countp, int *uclass_countp)
 378 {
 379         *device_countp = device_get_decendent_count(gd->dm_root);
 380         *uclass_countp = uclass_get_count();
 381 }
 382
 383 void dev_collect_stats(struct dm_stats *stats, const struct udevice *parent)
 384 {
 385         const struct udevice *dev;
 386         int i;
 387
 388         stats->dev_count++;
 389         stats->dev_size += sizeof(struct udevice);
 390         stats->dev_name_size += strlen(parent->name) + 1;
 391         for (i = 0; i < DM_TAG_ATTACH_COUNT; i++) {
 392                 int size = dev_get_attach_size(parent, i);
 393
 394                 if (size ||
 395                     (i == DM_TAG_DRIVER_DATA && parent->driver_data)) {
 396                         stats->attach_count[i]++;
 397                         stats->attach_size[i] += size;
 398                         stats->attach_count_total++;
 399                         stats->attach_size_total += size;
 400                 }
 401         }
 402
 403         list_for_each_entry(dev, &parent->child_head, sibling_node)
 404                 dev_collect_stats(stats, dev);
 405 }
 406
 407 void uclass_collect_stats(struct dm_stats *stats)
 408 {
 409         struct uclass *uc;
 410
 411         list_for_each_entry(uc, gd->uclass_root, sibling_node) {
 412                 int size;
 413
 414                 stats->uc_count++;
 415                 stats->uc_size += sizeof(struct uclass);
 416                 size = uc->uc_drv->priv_auto;
 417                 if (size) {
 418                         stats->uc_attach_count++;
 419                         stats->uc_attach_size += size;
 420                 }
 421         }
 422 }
 423
 424 void dm_get_mem(struct dm_stats *stats)
 425 {
 426         memset(stats, '\0', sizeof(*stats));
 427         dev_collect_stats(stats, gd->dm_root);
 428         uclass_collect_stats(stats);
 429         dev_tag_collect_stats(stats);
 430
 431         stats->total_size = stats->dev_size + stats->uc_size +
 432                 stats->attach_size_total + stats->uc_attach_size +
 433                 stats->tag_size;
 434 }
 435
 436 #if CONFIG_IS_ENABLED(ACPIGEN)
 437 static int root_acpi_get_name(const struct udevice *dev, char *out_name)
 438 {
 439         return acpi_copy_name(out_name, "\\_SB");
 440 }
 441
 442 struct acpi_ops root_acpi_ops = {
 443         .get_name       = root_acpi_get_name,
 444 };
 445 #endif
 446
 447 /* This is the root driver - all drivers are children of this */
 448 U_BOOT_DRIVER(root_driver) = {
 449         .name   = "root_driver",
 450         .id     = UCLASS_ROOT,
 451         ACPI_OPS_PTR(&root_acpi_ops)
 452 };
 453
 454 /* This is the root uclass */
 455 UCLASS_DRIVER(root) = {
 456         .name   = "root",
 457         .id     = UCLASS_ROOT,
 458 };