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