of/overlay.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Functions for working with device tree overlays
   4  *
   5  * Copyright (C) 2012 Pantelis Antoniou <panto@antoniou-consulting.com>
   6  * Copyright (C) 2012 Texas Instruments Inc.
   7  */
   8
   9 #define pr_fmt(fmt)     "OF: overlay: " fmt
  10
  11 #include <linux/kernel.h>
  12 #include <linux/module.h>
  13 #include <linux/of.h>
  14 #include <linux/of_device.h>
  15 #include <linux/of_fdt.h>
  16 #include <linux/string.h>
  17 #include <linux/ctype.h>
  18 #include <linux/errno.h>
  19 #include <linux/slab.h>
  20 #include <linux/libfdt.h>
  21 #include <linux/err.h>
  22 #include <linux/idr.h>
  23
  24 #include "of_private.h"
  25
  26 /**
  27  * struct target - info about current target node as recursing through overlay
  28  * @np:                 node where current level of overlay will be applied
  29  * @in_livetree:        @np is a node in the live devicetree
  30  *
  31  * Used in the algorithm to create the portion of a changeset that describes
  32  * an overlay fragment, which is a devicetree subtree.  Initially @np is a node
  33  * in the live devicetree where the overlay subtree is targeted to be grafted
  34  * into.  When recursing to the next level of the overlay subtree, the target
  35  * also recurses to the next level of the live devicetree, as long as overlay
  36  * subtree node also exists in the live devicetree.  When a node in the overlay
  37  * subtree does not exist at the same level in the live devicetree, target->np
  38  * points to a newly allocated node, and all subsequent targets in the subtree
  39  * will be newly allocated nodes.
  40  */
  41 struct target {
  42         struct device_node *np;
  43         bool in_livetree;
  44 };
  45
  46 /**
  47  * struct fragment - info about fragment nodes in overlay expanded device tree
  48  * @target:     target of the overlay operation
  49  * @overlay:    pointer to the __overlay__ node
  50  */
  51 struct fragment {
  52         struct device_node *target;
  53         struct device_node *overlay;
  54 };
  55
  56 /**
  57  * struct overlay_changeset
  58  * @id:                 changeset identifier
  59  * @ovcs_list:          list on which we are located
  60  * @fdt:                FDT that was unflattened to create @overlay_tree
  61  * @overlay_tree:       expanded device tree that contains the fragment nodes
  62  * @count:              count of fragment structures
  63  * @fragments:          fragment nodes in the overlay expanded device tree
  64  * @symbols_fragment:   last element of @fragments[] is the  __symbols__ node
  65  * @cset:               changeset to apply fragments to live device tree
  66  */
  67 struct overlay_changeset {
  68         int id;
  69         struct list_head ovcs_list;
  70         const void *fdt;
  71         struct device_node *overlay_tree;
  72         int count;
  73         struct fragment *fragments;
  74         bool symbols_fragment;
  75         struct of_changeset cset;
  76 };
  77
  78 /* flags are sticky - once set, do not reset */
  79 static int devicetree_state_flags;
  80 #define DTSF_APPLY_FAIL         0x01
  81 #define DTSF_REVERT_FAIL        0x02
  82
  83 /*
  84  * If a changeset apply or revert encounters an error, an attempt will
  85  * be made to undo partial changes, but may fail.  If the undo fails
  86  * we do not know the state of the devicetree.
  87  */
  88 static int devicetree_corrupt(void)
  89 {
  90         return devicetree_state_flags &
  91                 (DTSF_APPLY_FAIL | DTSF_REVERT_FAIL);
  92 }
  93
  94 static int build_changeset_next_level(struct overlay_changeset *ovcs,
  95                 struct target *target, const struct device_node *overlay_node);
  96
  97 /*
  98  * of_resolve_phandles() finds the largest phandle in the live tree.
  99  * of_overlay_apply() may add a larger phandle to the live tree.
 100  * Do not allow race between two overlays being applied simultaneously:
 101  *    mutex_lock(&of_overlay_phandle_mutex)
 102  *    of_resolve_phandles()
 103  *    of_overlay_apply()
 104  *    mutex_unlock(&of_overlay_phandle_mutex)
 105  */
 106 static DEFINE_MUTEX(of_overlay_phandle_mutex);
 107
 108 void of_overlay_mutex_lock(void)
 109 {
 110         mutex_lock(&of_overlay_phandle_mutex);
 111 }
 112
 113 void of_overlay_mutex_unlock(void)
 114 {
 115         mutex_unlock(&of_overlay_phandle_mutex);
 116 }
 117
 118
 119 static LIST_HEAD(ovcs_list);
 120 static DEFINE_IDR(ovcs_idr);
 121
 122 static BLOCKING_NOTIFIER_HEAD(overlay_notify_chain);
 123
 124 /**
 125  * of_overlay_notifier_register() - Register notifier for overlay operations
 126  * @nb:         Notifier block to register
 127  *
 128  * Register for notification on overlay operations on device tree nodes. The
 129  * reported actions definied by @of_reconfig_change. The notifier callback
 130  * furthermore receives a pointer to the affected device tree node.
 131  *
 132  * Note that a notifier callback is not supposed to store pointers to a device
 133  * tree node or its content beyond @OF_OVERLAY_POST_REMOVE corresponding to the
 134  * respective node it received.
 135  */
 136 int of_overlay_notifier_register(struct notifier_block *nb)
 137 {
 138         return blocking_notifier_chain_register(&overlay_notify_chain, nb);
 139 }
 140 EXPORT_SYMBOL_GPL(of_overlay_notifier_register);
 141
 142 /**
 143  * of_overlay_notifier_register() - Unregister notifier for overlay operations
 144  * @nb:         Notifier block to unregister
 145  */
 146 int of_overlay_notifier_unregister(struct notifier_block *nb)
 147 {
 148         return blocking_notifier_chain_unregister(&overlay_notify_chain, nb);
 149 }
 150 EXPORT_SYMBOL_GPL(of_overlay_notifier_unregister);
 151
 152 static char *of_overlay_action_name[] = {
 153         "pre-apply",
 154         "post-apply",
 155         "pre-remove",
 156         "post-remove",
 157 };
 158
 159 static int overlay_notify(struct overlay_changeset *ovcs,
 160                 enum of_overlay_notify_action action)
 161 {
 162         struct of_overlay_notify_data nd;
 163         int i, ret;
 164
 165         for (i = 0; i < ovcs->count; i++) {
 166                 struct fragment *fragment = &ovcs->fragments[i];
 167
 168                 nd.target = fragment->target;
 169                 nd.overlay = fragment->overlay;
 170
 171                 ret = blocking_notifier_call_chain(&overlay_notify_chain,
 172                                                    action, &nd);
 173                 if (ret == NOTIFY_OK || ret == NOTIFY_STOP)
 174                         return 0;
 175                 if (ret) {
 176                         ret = notifier_to_errno(ret);
 177                         pr_err("overlay changeset %s notifier error %d, target: %pOF\n",
 178                                of_overlay_action_name[action], ret, nd.target);
 179                         return ret;
 180                 }
 181         }
 182
 183         return 0;
 184 }
 185
 186 /*
 187  * The values of properties in the "/__symbols__" node are paths in
 188  * the ovcs->overlay_tree.  When duplicating the properties, the paths
 189  * need to be adjusted to be the correct path for the live device tree.
 190  *
 191  * The paths refer to a node in the subtree of a fragment node's "__overlay__"
 192  * node, for example "/fragment@0/__overlay__/symbol_path_tail",
 193  * where symbol_path_tail can be a single node or it may be a multi-node path.
 194  *
 195  * The duplicated property value will be modified by replacing the
 196  * "/fragment_name/__overlay/" portion of the value  with the target
 197  * path from the fragment node.
 198  */
 199 static struct property *dup_and_fixup_symbol_prop(
 200                 struct overlay_changeset *ovcs, const struct property *prop)
 201 {
 202         struct fragment *fragment;
 203         struct property *new_prop;
 204         struct device_node *fragment_node;
 205         struct device_node *overlay_node;
 206         const char *path;
 207         const char *path_tail;
 208         const char *target_path;
 209         int k;
 210         int overlay_name_len;
 211         int path_len;
 212         int path_tail_len;
 213         int target_path_len;
 214
 215         if (!prop->value)
 216                 return NULL;
 217         if (strnlen(prop->value, prop->length) >= prop->length)
 218                 return NULL;
 219         path = prop->value;
 220         path_len = strlen(path);
 221
 222         if (path_len < 1)
 223                 return NULL;
 224         fragment_node = __of_find_node_by_path(ovcs->overlay_tree, path + 1);
 225         overlay_node = __of_find_node_by_path(fragment_node, "__overlay__/");
 226         of_node_put(fragment_node);
 227         of_node_put(overlay_node);
 228
 229         for (k = 0; k < ovcs->count; k++) {
 230                 fragment = &ovcs->fragments[k];
 231                 if (fragment->overlay == overlay_node)
 232                         break;
 233         }
 234         if (k >= ovcs->count)
 235                 return NULL;
 236
 237         overlay_name_len = snprintf(NULL, 0, "%pOF", fragment->overlay);
 238
 239         if (overlay_name_len > path_len)
 240                 return NULL;
 241         path_tail = path + overlay_name_len;
 242         path_tail_len = strlen(path_tail);
 243
 244         target_path = kasprintf(GFP_KERNEL, "%pOF", fragment->target);
 245         if (!target_path)
 246                 return NULL;
 247         target_path_len = strlen(target_path);
 248
 249         new_prop = kzalloc(sizeof(*new_prop), GFP_KERNEL);
 250         if (!new_prop)
 251                 goto err_free_target_path;
 252
 253         new_prop->name = kstrdup(prop->name, GFP_KERNEL);
 254         new_prop->length = target_path_len + path_tail_len + 1;
 255         new_prop->value = kzalloc(new_prop->length, GFP_KERNEL);
 256         if (!new_prop->name || !new_prop->value)
 257                 goto err_free_new_prop;
 258
 259         strcpy(new_prop->value, target_path);
 260         strcpy(new_prop->value + target_path_len, path_tail);
 261
 262         of_property_set_flag(new_prop, OF_DYNAMIC);
 263
 264         kfree(target_path);
 265
 266         return new_prop;
 267
 268 err_free_new_prop:
 269         kfree(new_prop->name);
 270         kfree(new_prop->value);
 271         kfree(new_prop);
 272 err_free_target_path:
 273         kfree(target_path);
 274
 275         return NULL;
 276 }
 277
 278 /**
 279  * add_changeset_property() - add @overlay_prop to overlay changeset
 280  * @ovcs:               overlay changeset
 281  * @target:             where @overlay_prop will be placed
 282  * @overlay_prop:       property to add or update, from overlay tree
 283  * @is_symbols_prop:    1 if @overlay_prop is from node "/__symbols__"
 284  *
 285  * If @overlay_prop does not already exist in live devicetree, add changeset
 286  * entry to add @overlay_prop in @target, else add changeset entry to update
 287  * value of @overlay_prop.
 288  *
 289  * @target may be either in the live devicetree or in a new subtree that
 290  * is contained in the changeset.
 291  *
 292  * Some special properties are not added or updated (no error returned):
 293  * "name", "phandle", "linux,phandle".
 294  *
 295  * Properties "#address-cells" and "#size-cells" are not updated if they
 296  * are already in the live tree, but if present in the live tree, the values
 297  * in the overlay must match the values in the live tree.
 298  *
 299  * Update of property in symbols node is not allowed.
 300  *
 301  * Returns 0 on success, -ENOMEM if memory allocation failure, or -EINVAL if
 302  * invalid @overlay.
 303  */
 304 static int add_changeset_property(struct overlay_changeset *ovcs,
 305                 struct target *target, struct property *overlay_prop,
 306                 bool is_symbols_prop)
 307 {
 308         struct property *new_prop = NULL, *prop;
 309         int ret = 0;
 310
 311         if (target->in_livetree)
 312                 if (!of_prop_cmp(overlay_prop->name, "name") ||
 313                     !of_prop_cmp(overlay_prop->name, "phandle") ||
 314                     !of_prop_cmp(overlay_prop->name, "linux,phandle"))
 315                         return 0;
 316
 317         if (target->in_livetree)
 318                 prop = of_find_property(target->np, overlay_prop->name, NULL);
 319         else
 320                 prop = NULL;
 321
 322         if (prop) {
 323                 if (!of_prop_cmp(prop->name, "#address-cells")) {
 324                         if (!of_prop_val_eq(prop, overlay_prop)) {
 325                                 pr_err("ERROR: changing value of #address-cells is not allowed in %pOF\n",
 326                                        target->np);
 327                                 ret = -EINVAL;
 328                         }
 329                         return ret;
 330
 331                 } else if (!of_prop_cmp(prop->name, "#size-cells")) {
 332                         if (!of_prop_val_eq(prop, overlay_prop)) {
 333                                 pr_err("ERROR: changing value of #size-cells is not allowed in %pOF\n",
 334                                        target->np);
 335                                 ret = -EINVAL;
 336                         }
 337                         return ret;
 338                 }
 339         }
 340
 341         if (is_symbols_prop) {
 342                 if (prop)
 343                         return -EINVAL;
 344                 new_prop = dup_and_fixup_symbol_prop(ovcs, overlay_prop);
 345         } else {
 346                 new_prop = __of_prop_dup(overlay_prop, GFP_KERNEL);
 347         }
 348
 349         if (!new_prop)
 350                 return -ENOMEM;
 351
 352         if (!prop) {
 353                 if (!target->in_livetree) {
 354                         new_prop->next = target->np->deadprops;
 355                         target->np->deadprops = new_prop;
 356                 }
 357                 ret = of_changeset_add_property(&ovcs->cset, target->np,
 358                                                 new_prop);
 359         } else {
 360                 ret = of_changeset_update_property(&ovcs->cset, target->np,
 361                                                    new_prop);
 362         }
 363
 364         if (!of_node_check_flag(target->np, OF_OVERLAY))
 365                 pr_err("WARNING: memory leak will occur if overlay removed, property: %pOF/%s\n",
 366                        target->np, new_prop->name);
 367
 368         if (ret) {
 369                 kfree(new_prop->name);
 370                 kfree(new_prop->value);
 371                 kfree(new_prop);
 372         }
 373         return ret;
 374 }
 375
 376 /**
 377  * add_changeset_node() - add @node (and children) to overlay changeset
 378  * @ovcs:       overlay changeset
 379  * @target:     where @node will be placed in live tree or changeset
 380  * @node:       node from within overlay device tree fragment
 381  *
 382  * If @node does not already exist in @target, add changeset entry
 383  * to add @node in @target.
 384  *
 385  * If @node already exists in @target, and the existing node has
 386  * a phandle, the overlay node is not allowed to have a phandle.
 387  *
 388  * If @node has child nodes, add the children recursively via
 389  * build_changeset_next_level().
 390  *
 391  * NOTE_1: A live devicetree created from a flattened device tree (FDT) will
 392  *       not contain the full path in node->full_name.  Thus an overlay
 393  *       created from an FDT also will not contain the full path in
 394  *       node->full_name.  However, a live devicetree created from Open
 395  *       Firmware may have the full path in node->full_name.
 396  *
 397  *       add_changeset_node() follows the FDT convention and does not include
 398  *       the full path in node->full_name.  Even though it expects the overlay
 399  *       to not contain the full path, it uses kbasename() to remove the
 400  *       full path should it exist.  It also uses kbasename() in comparisons
 401  *       to nodes in the live devicetree so that it can apply an overlay to
 402  *       a live devicetree created from Open Firmware.
 403  *
 404  * NOTE_2: Multiple mods of created nodes not supported.
 405  *       If more than one fragment contains a node that does not already exist
 406  *       in the live tree, then for each fragment of_changeset_attach_node()
 407  *       will add a changeset entry to add the node.  When the changeset is
 408  *       applied, __of_attach_node() will attach the node twice (once for
 409  *       each fragment).  At this point the device tree will be corrupted.
 410  *
 411  *       TODO: add integrity check to ensure that multiple fragments do not
 412  *             create the same node.
 413  *
 414  * Returns 0 on success, -ENOMEM if memory allocation failure, or -EINVAL if
 415  * invalid @overlay.
 416  */
 417 static int add_changeset_node(struct overlay_changeset *ovcs,
 418                 struct target *target, struct device_node *node)
 419 {
 420         const char *node_kbasename;
 421         const __be32 *phandle;
 422         struct device_node *tchild;
 423         struct target target_child;
 424         int ret = 0, size;
 425
 426         node_kbasename = kbasename(node->full_name);
 427
 428         for_each_child_of_node(target->np, tchild)
 429                 if (!of_node_cmp(node_kbasename, kbasename(tchild->full_name)))
 430                         break;
 431
 432         if (!tchild) {
 433                 tchild = __of_node_dup(NULL, node_kbasename);
 434                 if (!tchild)
 435                         return -ENOMEM;
 436
 437                 tchild->parent = target->np;
 438                 tchild->name = __of_get_property(node, "name", NULL);
 439                 tchild->type = __of_get_property(node, "device_type", NULL);
 440
 441                 if (!tchild->name)
 442                         tchild->name = "<NULL>";
 443                 if (!tchild->type)
 444                         tchild->type = "<NULL>";
 445
 446                 /* ignore obsolete "linux,phandle" */
 447                 phandle = __of_get_property(node, "phandle", &size);
 448                 if (phandle && (size == 4))
 449                         tchild->phandle = be32_to_cpup(phandle);
 450
 451                 of_node_set_flag(tchild, OF_OVERLAY);
 452
 453                 ret = of_changeset_attach_node(&ovcs->cset, tchild);
 454                 if (ret)
 455                         return ret;
 456
 457                 target_child.np = tchild;
 458                 target_child.in_livetree = false;
 459
 460                 ret = build_changeset_next_level(ovcs, &target_child, node);
 461                 of_node_put(tchild);
 462                 return ret;
 463         }
 464
 465         if (node->phandle && tchild->phandle) {
 466                 ret = -EINVAL;
 467         } else {
 468                 target_child.np = tchild;
 469                 target_child.in_livetree = target->in_livetree;
 470                 ret = build_changeset_next_level(ovcs, &target_child, node);
 471         }
 472         of_node_put(tchild);
 473
 474         return ret;
 475 }
 476
 477 /**
 478  * build_changeset_next_level() - add level of overlay changeset
 479  * @ovcs:               overlay changeset
 480  * @target:             where to place @overlay_node in live tree
 481  * @overlay_node:       node from within an overlay device tree fragment
 482  *
 483  * Add the properties (if any) and nodes (if any) from @overlay_node to the
 484  * @ovcs->cset changeset.  If an added node has child nodes, they will
 485  * be added recursively.
 486  *
 487  * Do not allow symbols node to have any children.
 488  *
 489  * Returns 0 on success, -ENOMEM if memory allocation failure, or -EINVAL if
 490  * invalid @overlay_node.
 491  */
 492 static int build_changeset_next_level(struct overlay_changeset *ovcs,
 493                 struct target *target, const struct device_node *overlay_node)
 494 {
 495         struct device_node *child;
 496         struct property *prop;
 497         int ret;
 498
 499         for_each_property_of_node(overlay_node, prop) {
 500                 ret = add_changeset_property(ovcs, target, prop, 0);
 501                 if (ret) {
 502                         pr_debug("Failed to apply prop @%pOF/%s, err=%d\n",
 503                                  target->np, prop->name, ret);
 504                         return ret;
 505                 }
 506         }
 507
 508         for_each_child_of_node(overlay_node, child) {
 509                 ret = add_changeset_node(ovcs, target, child);
 510                 if (ret) {
 511                         pr_debug("Failed to apply node @%pOF/%pOFn, err=%d\n",
 512                                  target->np, child, ret);
 513                         of_node_put(child);
 514                         return ret;
 515                 }
 516         }
 517
 518         return 0;
 519 }
 520
 521 /*
 522  * Add the properties from __overlay__ node to the @ovcs->cset changeset.
 523  */
 524 static int build_changeset_symbols_node(struct overlay_changeset *ovcs,
 525                 struct target *target,
 526                 const struct device_node *overlay_symbols_node)
 527 {
 528         struct property *prop;
 529         int ret;
 530
 531         for_each_property_of_node(overlay_symbols_node, prop) {
 532                 ret = add_changeset_property(ovcs, target, prop, 1);
 533                 if (ret) {
 534                         pr_debug("Failed to apply prop @%pOF/%s, err=%d\n",
 535                                  target->np, prop->name, ret);
 536                         return ret;
 537                 }
 538         }
 539
 540         return 0;
 541 }
 542
 543 /**
 544  * build_changeset() - populate overlay changeset in @ovcs from @ovcs->fragments
 545  * @ovcs:       Overlay changeset
 546  *
 547  * Create changeset @ovcs->cset to contain the nodes and properties of the
 548  * overlay device tree fragments in @ovcs->fragments[].  If an error occurs,
 549  * any portions of the changeset that were successfully created will remain
 550  * in @ovcs->cset.
 551  *
 552  * Returns 0 on success, -ENOMEM if memory allocation failure, or -EINVAL if
 553  * invalid overlay in @ovcs->fragments[].
 554  */
 555 static int build_changeset(struct overlay_changeset *ovcs)
 556 {
 557         struct fragment *fragment;
 558         struct target target;
 559         int fragments_count, i, ret;
 560
 561         /*
 562          * if there is a symbols fragment in ovcs->fragments[i] it is
 563          * the final element in the array
 564          */
 565         if (ovcs->symbols_fragment)
 566                 fragments_count = ovcs->count - 1;
 567         else
 568                 fragments_count = ovcs->count;
 569
 570         for (i = 0; i < fragments_count; i++) {
 571                 fragment = &ovcs->fragments[i];
 572
 573                 target.np = fragment->target;
 574                 target.in_livetree = true;
 575                 ret = build_changeset_next_level(ovcs, &target,
 576                                                  fragment->overlay);
 577                 if (ret) {
 578                         pr_debug("apply failed '%pOF'\n", fragment->target);
 579                         return ret;
 580                 }
 581         }
 582
 583         if (ovcs->symbols_fragment) {
 584                 fragment = &ovcs->fragments[ovcs->count - 1];
 585
 586                 target.np = fragment->target;
 587                 target.in_livetree = true;
 588                 ret = build_changeset_symbols_node(ovcs, &target,
 589                                                    fragment->overlay);
 590                 if (ret) {
 591                         pr_debug("apply failed '%pOF'\n", fragment->target);
 592                         return ret;
 593                 }
 594         }
 595
 596         return 0;
 597 }
 598
 599 /*
 600  * Find the target node using a number of different strategies
 601  * in order of preference:
 602  *
 603  * 1) "target" property containing the phandle of the target
 604  * 2) "target-path" property containing the path of the target
 605  */
 606 static struct device_node *find_target(struct device_node *info_node)
 607 {
 608         struct device_node *node;
 609         const char *path;
 610         u32 val;
 611         int ret;
 612
 613         ret = of_property_read_u32(info_node, "target", &val);
 614         if (!ret) {
 615                 node = of_find_node_by_phandle(val);
 616                 if (!node)
 617                         pr_err("find target, node: %pOF, phandle 0x%x not found\n",
 618                                info_node, val);
 619                 return node;
 620         }
 621
 622         ret = of_property_read_string(info_node, "target-path", &path);
 623         if (!ret) {
 624                 node =  of_find_node_by_path(path);
 625                 if (!node)
 626                         pr_err("find target, node: %pOF, path '%s' not found\n",
 627                                info_node, path);
 628                 return node;
 629         }
 630
 631         pr_err("find target, node: %pOF, no target property\n", info_node);
 632
 633         return NULL;
 634 }
 635
 636 /**
 637  * init_overlay_changeset() - initialize overlay changeset from overlay tree
 638  * @ovcs:       Overlay changeset to build
 639  * @fdt:        the FDT that was unflattened to create @tree
 640  * @tree:       Contains all the overlay fragments and overlay fixup nodes
 641  *
 642  * Initialize @ovcs.  Populate @ovcs->fragments with node information from
 643  * the top level of @tree.  The relevant top level nodes are the fragment
 644  * nodes and the __symbols__ node.  Any other top level node will be ignored.
 645  *
 646  * Returns 0 on success, -ENOMEM if memory allocation failure, -EINVAL if error
 647  * detected in @tree, or -ENOSPC if idr_alloc() error.
 648  */
 649 static int init_overlay_changeset(struct overlay_changeset *ovcs,
 650                 const void *fdt, struct device_node *tree)
 651 {
 652         struct device_node *node, *overlay_node;
 653         struct fragment *fragment;
 654         struct fragment *fragments;
 655         int cnt, id, ret;
 656
 657         /*
 658          * Warn for some issues.  Can not return -EINVAL for these until
 659          * of_unittest_apply_overlay() is fixed to pass these checks.
 660          */
 661         if (!of_node_check_flag(tree, OF_DYNAMIC))
 662                 pr_debug("%s() tree is not dynamic\n", __func__);
 663
 664         if (!of_node_check_flag(tree, OF_DETACHED))
 665                 pr_debug("%s() tree is not detached\n", __func__);
 666
 667         if (!of_node_is_root(tree))
 668                 pr_debug("%s() tree is not root\n", __func__);
 669
 670         ovcs->overlay_tree = tree;
 671         ovcs->fdt = fdt;
 672
 673         INIT_LIST_HEAD(&ovcs->ovcs_list);
 674
 675         of_changeset_init(&ovcs->cset);
 676
 677         id = idr_alloc(&ovcs_idr, ovcs, 1, 0, GFP_KERNEL);
 678         if (id <= 0)
 679                 return id;
 680
 681         cnt = 0;
 682
 683         /* fragment nodes */
 684         for_each_child_of_node(tree, node) {
 685                 overlay_node = of_get_child_by_name(node, "__overlay__");
 686                 if (overlay_node) {
 687                         cnt++;
 688                         of_node_put(overlay_node);
 689                 }
 690         }
 691
 692         node = of_get_child_by_name(tree, "__symbols__");
 693         if (node) {
 694                 cnt++;
 695                 of_node_put(node);
 696         }
 697
 698         fragments = kcalloc(cnt, sizeof(*fragments), GFP_KERNEL);
 699         if (!fragments) {
 700                 ret = -ENOMEM;
 701                 goto err_free_idr;
 702         }
 703
 704         cnt = 0;
 705         for_each_child_of_node(tree, node) {
 706                 overlay_node = of_get_child_by_name(node, "__overlay__");
 707                 if (!overlay_node)
 708                         continue;
 709
 710                 fragment = &fragments[cnt];
 711                 fragment->overlay = overlay_node;
 712                 fragment->target = find_target(node);
 713                 if (!fragment->target) {
 714                         of_node_put(fragment->overlay);
 715                         ret = -EINVAL;
 716                         goto err_free_fragments;
 717                 }
 718
 719                 cnt++;
 720         }
 721
 722         /*
 723          * if there is a symbols fragment in ovcs->fragments[i] it is
 724          * the final element in the array
 725          */
 726         node = of_get_child_by_name(tree, "__symbols__");
 727         if (node) {
 728                 ovcs->symbols_fragment = 1;
 729                 fragment = &fragments[cnt];
 730                 fragment->overlay = node;
 731                 fragment->target = of_find_node_by_path("/__symbols__");
 732
 733                 if (!fragment->target) {
 734                         pr_err("symbols in overlay, but not in live tree\n");
 735                         ret = -EINVAL;
 736                         goto err_free_fragments;
 737                 }
 738
 739                 cnt++;
 740         }
 741
 742         if (!cnt) {
 743                 pr_err("no fragments or symbols in overlay\n");
 744                 ret = -EINVAL;
 745                 goto err_free_fragments;
 746         }
 747
 748         ovcs->id = id;
 749         ovcs->count = cnt;
 750         ovcs->fragments = fragments;
 751
 752         return 0;
 753
 754 err_free_fragments:
 755         kfree(fragments);
 756 err_free_idr:
 757         idr_remove(&ovcs_idr, id);
 758
 759         pr_err("%s() failed, ret = %d\n", __func__, ret);
 760
 761         return ret;
 762 }
 763
 764 static void free_overlay_changeset(struct overlay_changeset *ovcs)
 765 {
 766         int i;
 767
 768         if (ovcs->cset.entries.next)
 769                 of_changeset_destroy(&ovcs->cset);
 770
 771         if (ovcs->id)
 772                 idr_remove(&ovcs_idr, ovcs->id);
 773
 774         for (i = 0; i < ovcs->count; i++) {
 775                 of_node_put(ovcs->fragments[i].target);
 776                 of_node_put(ovcs->fragments[i].overlay);
 777         }
 778         kfree(ovcs->fragments);
 779         /*
 780          * There should be no live pointers into ovcs->overlay_tree and
 781          * ovcs->fdt due to the policy that overlay notifiers are not allowed
 782          * to retain pointers into the overlay devicetree.
 783          */
 784         kfree(ovcs->overlay_tree);
 785         kfree(ovcs->fdt);
 786         kfree(ovcs);
 787 }
 788
 789 /*
 790  * internal documentation
 791  *
 792  * of_overlay_apply() - Create and apply an overlay changeset
 793  * @fdt:        the FDT that was unflattened to create @tree
 794  * @tree:       Expanded overlay device tree
 795  * @ovcs_id:    Pointer to overlay changeset id
 796  *
 797  * Creates and applies an overlay changeset.
 798  *
 799  * If an error occurs in a pre-apply notifier, then no changes are made
 800  * to the device tree.
 801  *
 802
 803  * A non-zero return value will not have created the changeset if error is from:
 804  *   - parameter checks
 805  *   - building the changeset
 806  *   - overlay changeset pre-apply notifier
 807  *
 808  * If an error is returned by an overlay changeset pre-apply notifier
 809  * then no further overlay changeset pre-apply notifier will be called.
 810  *
 811  * A non-zero return value will have created the changeset if error is from:
 812  *   - overlay changeset entry notifier
 813  *   - overlay changeset post-apply notifier
 814  *
 815  * If an error is returned by an overlay changeset post-apply notifier
 816  * then no further overlay changeset post-apply notifier will be called.
 817  *
 818  * If more than one notifier returns an error, then the last notifier
 819  * error to occur is returned.
 820  *
 821  * If an error occurred while applying the overlay changeset, then an
 822  * attempt is made to revert any changes that were made to the
 823  * device tree.  If there were any errors during the revert attempt
 824  * then the state of the device tree can not be determined, and any
 825  * following attempt to apply or remove an overlay changeset will be
 826  * refused.
 827  *
 828  * Returns 0 on success, or a negative error number.  Overlay changeset
 829  * id is returned to *ovcs_id.
 830  */
 831
 832 static int of_overlay_apply(const void *fdt, struct device_node *tree,
 833                 int *ovcs_id)
 834 {
 835         struct overlay_changeset *ovcs;
 836         int ret = 0, ret_revert, ret_tmp;
 837
 838         /*
 839          * As of this point, fdt and tree belong to the overlay changeset.
 840          * overlay changeset code is responsible for freeing them.
 841          */
 842
 843         if (devicetree_corrupt()) {
 844                 pr_err("devicetree state suspect, refuse to apply overlay\n");
 845                 kfree(fdt);
 846                 kfree(tree);
 847                 ret = -EBUSY;
 848                 goto out;
 849         }
 850
 851         ovcs = kzalloc(sizeof(*ovcs), GFP_KERNEL);
 852         if (!ovcs) {
 853                 kfree(fdt);
 854                 kfree(tree);
 855                 ret = -ENOMEM;
 856                 goto out;
 857         }
 858
 859         of_overlay_mutex_lock();
 860         mutex_lock(&of_mutex);
 861
 862         ret = of_resolve_phandles(tree);
 863         if (ret)
 864                 goto err_free_tree;
 865
 866         ret = init_overlay_changeset(ovcs, fdt, tree);
 867         if (ret)
 868                 goto err_free_tree;
 869
 870         /*
 871          * after overlay_notify(), ovcs->overlay_tree related pointers may have
 872          * leaked to drivers, so can not kfree() tree, aka ovcs->overlay_tree;
 873          * and can not free fdt, aka ovcs->fdt
 874          */
 875         ret = overlay_notify(ovcs, OF_OVERLAY_PRE_APPLY);
 876         if (ret) {
 877                 pr_err("overlay changeset pre-apply notify error %d\n", ret);
 878                 goto err_free_overlay_changeset;
 879         }
 880
 881         ret = build_changeset(ovcs);
 882         if (ret)
 883                 goto err_free_overlay_changeset;
 884
 885         ret_revert = 0;
 886         ret = __of_changeset_apply_entries(&ovcs->cset, &ret_revert);
 887         if (ret) {
 888                 if (ret_revert) {
 889                         pr_debug("overlay changeset revert error %d\n",
 890                                  ret_revert);
 891                         devicetree_state_flags |= DTSF_APPLY_FAIL;
 892                 }
 893                 goto err_free_overlay_changeset;
 894         }
 895
 896         of_populate_phandle_cache();
 897
 898         ret = __of_changeset_apply_notify(&ovcs->cset);
 899         if (ret)
 900                 pr_err("overlay changeset entry notify error %d\n", ret);
 901         /* notify failure is not fatal, continue */
 902
 903         list_add_tail(&ovcs->ovcs_list, &ovcs_list);
 904         *ovcs_id = ovcs->id;
 905
 906         ret_tmp = overlay_notify(ovcs, OF_OVERLAY_POST_APPLY);
 907         if (ret_tmp) {
 908                 pr_err("overlay changeset post-apply notify error %d\n",
 909                        ret_tmp);
 910                 if (!ret)
 911                         ret = ret_tmp;
 912         }
 913
 914         goto out_unlock;
 915
 916 err_free_tree:
 917         kfree(fdt);
 918         kfree(tree);
 919
 920 err_free_overlay_changeset:
 921         free_overlay_changeset(ovcs);
 922
 923 out_unlock:
 924         mutex_unlock(&of_mutex);
 925         of_overlay_mutex_unlock();
 926
 927 out:
 928         pr_debug("%s() err=%d\n", __func__, ret);
 929
 930         return ret;
 931 }
 932
 933 int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size,
 934                          int *ovcs_id)
 935 {
 936         const void *new_fdt;
 937         int ret;
 938         u32 size;
 939         struct device_node *overlay_root;
 940
 941         *ovcs_id = 0;
 942         ret = 0;
 943
 944         if (overlay_fdt_size < sizeof(struct fdt_header) ||
 945             fdt_check_header(overlay_fdt)) {
 946                 pr_err("Invalid overlay_fdt header\n");
 947                 return -EINVAL;
 948         }
 949
 950         size = fdt_totalsize(overlay_fdt);
 951         if (overlay_fdt_size < size)
 952                 return -EINVAL;
 953
 954         /*
 955          * Must create permanent copy of FDT because of_fdt_unflatten_tree()
 956          * will create pointers to the passed in FDT in the unflattened tree.
 957          */
 958         new_fdt = kmemdup(overlay_fdt, size, GFP_KERNEL);
 959         if (!new_fdt)
 960                 return -ENOMEM;
 961
 962         of_fdt_unflatten_tree(new_fdt, NULL, &overlay_root);
 963         if (!overlay_root) {
 964                 pr_err("unable to unflatten overlay_fdt\n");
 965                 ret = -EINVAL;
 966                 goto out_free_new_fdt;
 967         }
 968
 969         ret = of_overlay_apply(new_fdt, overlay_root, ovcs_id);
 970         if (ret < 0) {
 971                 /*
 972                  * new_fdt and overlay_root now belong to the overlay
 973                  * changeset.
 974                  * overlay changeset code is responsible for freeing them.
 975                  */
 976                 goto out;
 977         }
 978
 979         return 0;
 980
 981
 982 out_free_new_fdt:
 983         kfree(new_fdt);
 984
 985 out:
 986         return ret;
 987 }
 988 EXPORT_SYMBOL_GPL(of_overlay_fdt_apply);
 989
 990 /*
 991  * Find @np in @tree.
 992  *
 993  * Returns 1 if @np is @tree or is contained in @tree, else 0
 994  */
 995 static int find_node(struct device_node *tree, struct device_node *np)
 996 {
 997         struct device_node *child;
 998
 999         if (tree == np)
1000                 return 1;
1001
1002         for_each_child_of_node(tree, child) {
1003                 if (find_node(child, np)) {
1004                         of_node_put(child);
1005                         return 1;
1006                 }
1007         }
1008
1009         return 0;
1010 }
1011
1012 /*
1013  * Is @remove_ce_node a child of, a parent of, or the same as any
1014  * node in an overlay changeset more topmost than @remove_ovcs?
1015  *
1016  * Returns 1 if found, else 0
1017  */
1018 static int node_overlaps_later_cs(struct overlay_changeset *remove_ovcs,
1019                 struct device_node *remove_ce_node)
1020 {
1021         struct overlay_changeset *ovcs;
1022         struct of_changeset_entry *ce;
1023
1024         list_for_each_entry_reverse(ovcs, &ovcs_list, ovcs_list) {
1025                 if (ovcs == remove_ovcs)
1026                         break;
1027
1028                 list_for_each_entry(ce, &ovcs->cset.entries, node) {
1029                         if (find_node(ce->np, remove_ce_node)) {
1030                                 pr_err("%s: #%d overlaps with #%d @%pOF\n",
1031                                         __func__, remove_ovcs->id, ovcs->id,
1032                                         remove_ce_node);
1033                                 return 1;
1034                         }
1035                         if (find_node(remove_ce_node, ce->np)) {
1036                                 pr_err("%s: #%d overlaps with #%d @%pOF\n",
1037                                         __func__, remove_ovcs->id, ovcs->id,
1038                                         remove_ce_node);
1039                                 return 1;
1040                         }
1041                 }
1042         }
1043
1044         return 0;
1045 }
1046
1047 /*
1048  * We can safely remove the overlay only if it's the top-most one.
1049  * Newly applied overlays are inserted at the tail of the overlay list,
1050  * so a top most overlay is the one that is closest to the tail.
1051  *
1052  * The topmost check is done by exploiting this property. For each
1053  * affected device node in the log list we check if this overlay is
1054  * the one closest to the tail. If another overlay has affected this
1055  * device node and is closest to the tail, then removal is not permited.
1056  */
1057 static int overlay_removal_is_ok(struct overlay_changeset *remove_ovcs)
1058 {
1059         struct of_changeset_entry *remove_ce;
1060
1061         list_for_each_entry(remove_ce, &remove_ovcs->cset.entries, node) {
1062                 if (node_overlaps_later_cs(remove_ovcs, remove_ce->np)) {
1063                         pr_err("overlay #%d is not topmost\n", remove_ovcs->id);
1064                         return 0;
1065                 }
1066         }
1067
1068         return 1;
1069 }
1070
1071 /**
1072  * of_overlay_remove() - Revert and free an overlay changeset
1073  * @ovcs_id:    Pointer to overlay changeset id
1074  *
1075  * Removes an overlay if it is permissible.  @ovcs_id was previously returned
1076  * by of_overlay_fdt_apply().
1077  *
1078  * If an error occurred while attempting to revert the overlay changeset,
1079  * then an attempt is made to re-apply any changeset entry that was
1080  * reverted.  If an error occurs on re-apply then the state of the device
1081  * tree can not be determined, and any following attempt to apply or remove
1082  * an overlay changeset will be refused.
1083  *
1084  * A non-zero return value will not revert the changeset if error is from:
1085  *   - parameter checks
1086  *   - overlay changeset pre-remove notifier
1087  *   - overlay changeset entry revert
1088  *
1089  * If an error is returned by an overlay changeset pre-remove notifier
1090  * then no further overlay changeset pre-remove notifier will be called.
1091  *
1092  * If more than one notifier returns an error, then the last notifier
1093  * error to occur is returned.
1094  *
1095  * A non-zero return value will revert the changeset if error is from:
1096  *   - overlay changeset entry notifier
1097  *   - overlay changeset post-remove notifier
1098  *
1099  * If an error is returned by an overlay changeset post-remove notifier
1100  * then no further overlay changeset post-remove notifier will be called.
1101  *
1102  * Returns 0 on success, or a negative error number.  *ovcs_id is set to
1103  * zero after reverting the changeset, even if a subsequent error occurs.
1104  */
1105 int of_overlay_remove(int *ovcs_id)
1106 {
1107         struct overlay_changeset *ovcs;
1108         int ret, ret_apply, ret_tmp;
1109
1110         ret = 0;
1111
1112         if (devicetree_corrupt()) {
1113                 pr_err("suspect devicetree state, refuse to remove overlay\n");
1114                 ret = -EBUSY;
1115                 goto out;
1116         }
1117
1118         mutex_lock(&of_mutex);
1119
1120         ovcs = idr_find(&ovcs_idr, *ovcs_id);
1121         if (!ovcs) {
1122                 ret = -ENODEV;
1123                 pr_err("remove: Could not find overlay #%d\n", *ovcs_id);
1124                 goto out_unlock;
1125         }
1126
1127         if (!overlay_removal_is_ok(ovcs)) {
1128                 ret = -EBUSY;
1129                 goto out_unlock;
1130         }
1131
1132         ret = overlay_notify(ovcs, OF_OVERLAY_PRE_REMOVE);
1133         if (ret) {
1134                 pr_err("overlay changeset pre-remove notify error %d\n", ret);
1135                 goto out_unlock;
1136         }
1137
1138         list_del(&ovcs->ovcs_list);
1139
1140         /*
1141          * Disable phandle cache.  Avoids race condition that would arise
1142          * from removing cache entry when the associated node is deleted.
1143          */
1144         of_free_phandle_cache();
1145
1146         ret_apply = 0;
1147         ret = __of_changeset_revert_entries(&ovcs->cset, &ret_apply);
1148
1149         of_populate_phandle_cache();
1150
1151         if (ret) {
1152                 if (ret_apply)
1153                         devicetree_state_flags |= DTSF_REVERT_FAIL;
1154                 goto out_unlock;
1155         }
1156
1157         ret = __of_changeset_revert_notify(&ovcs->cset);
1158         if (ret)
1159                 pr_err("overlay changeset entry notify error %d\n", ret);
1160         /* notify failure is not fatal, continue */
1161
1162         *ovcs_id = 0;
1163
1164         ret_tmp = overlay_notify(ovcs, OF_OVERLAY_POST_REMOVE);
1165         if (ret_tmp) {
1166                 pr_err("overlay changeset post-remove notify error %d\n",
1167                        ret_tmp);
1168                 if (!ret)
1169                         ret = ret_tmp;
1170         }
1171
1172         free_overlay_changeset(ovcs);
1173
1174 out_unlock:
1175         mutex_unlock(&of_mutex);
1176
1177 out:
1178         pr_debug("%s() err=%d\n", __func__, ret);
1179
1180         return ret;
1181 }
1182 EXPORT_SYMBOL_GPL(of_overlay_remove);
1183
1184 /**
1185  * of_overlay_remove_all() - Reverts and frees all overlay changesets
1186  *
1187  * Removes all overlays from the system in the correct order.
1188  *
1189  * Returns 0 on success, or a negative error number
1190  */
1191 int of_overlay_remove_all(void)
1192 {
1193         struct overlay_changeset *ovcs, *ovcs_n;
1194         int ret;
1195
1196         /* the tail of list is guaranteed to be safe to remove */
1197         list_for_each_entry_safe_reverse(ovcs, ovcs_n, &ovcs_list, ovcs_list) {
1198                 ret = of_overlay_remove(&ovcs->id);
1199                 if (ret)
1200                         return ret;
1201         }
1202
1203         return 0;
1204 }
1205 EXPORT_SYMBOL_GPL(of_overlay_remove_all);