drivers/of/overlay.c

   1 /*
   2  * Functions for working with device tree overlays
   3  *
   4  * Copyright (C) 2012 Pantelis Antoniou <panto@antoniou-consulting.com>
   5  * Copyright (C) 2012 Texas Instruments Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * version 2 as published by the Free Software Foundation.
  10  */
  11
  12 #define pr_fmt(fmt)     "OF: overlay: " fmt
  13
  14 #include <linux/kernel.h>
  15 #include <linux/module.h>
  16 #include <linux/of.h>
  17 #include <linux/of_device.h>
  18 #include <linux/string.h>
  19 #include <linux/ctype.h>
  20 #include <linux/errno.h>
  21 #include <linux/slab.h>
  22 #include <linux/err.h>
  23 #include <linux/idr.h>
  24
  25 #include "of_private.h"
  26
  27 /**
  28  * struct of_overlay_info - Holds a single overlay info
  29  * @target:     target of the overlay operation
  30  * @overlay:    pointer to the overlay contents node
  31  *
  32  * Holds a single overlay state, including all the overlay logs &
  33  * records.
  34  */
  35 struct of_overlay_info {
  36         struct device_node *target;
  37         struct device_node *overlay;
  38 };
  39
  40 /**
  41  * struct of_overlay - Holds a complete overlay transaction
  42  * @node:       List on which we are located
  43  * @count:      Count of ovinfo structures
  44  * @ovinfo_tab: Overlay info table (count sized)
  45  * @cset:       Changeset to be used
  46  *
  47  * Holds a complete overlay transaction
  48  */
  49 struct of_overlay {
  50         int id;
  51         struct list_head node;
  52         int count;
  53         struct of_overlay_info *ovinfo_tab;
  54         struct of_changeset cset;
  55 };
  56
  57 static int of_overlay_apply_one(struct of_overlay *ov,
  58                 struct device_node *target, const struct device_node *overlay);
  59
  60 static BLOCKING_NOTIFIER_HEAD(of_overlay_chain);
  61
  62 int of_overlay_notifier_register(struct notifier_block *nb)
  63 {
  64         return blocking_notifier_chain_register(&of_overlay_chain, nb);
  65 }
  66 EXPORT_SYMBOL_GPL(of_overlay_notifier_register);
  67
  68 int of_overlay_notifier_unregister(struct notifier_block *nb)
  69 {
  70         return blocking_notifier_chain_unregister(&of_overlay_chain, nb);
  71 }
  72 EXPORT_SYMBOL_GPL(of_overlay_notifier_unregister);
  73
  74 static int of_overlay_notify(struct of_overlay *ov,
  75                              enum of_overlay_notify_action action)
  76 {
  77         struct of_overlay_notify_data nd;
  78         int i, ret;
  79
  80         for (i = 0; i < ov->count; i++) {
  81                 struct of_overlay_info *ovinfo = &ov->ovinfo_tab[i];
  82
  83                 nd.target = ovinfo->target;
  84                 nd.overlay = ovinfo->overlay;
  85
  86                 ret = blocking_notifier_call_chain(&of_overlay_chain,
  87                                                    action, &nd);
  88                 if (ret)
  89                         return notifier_to_errno(ret);
  90         }
  91
  92         return 0;
  93 }
  94
  95 static int of_overlay_apply_single_property(struct of_overlay *ov,
  96                 struct device_node *target, struct property *prop)
  97 {
  98         struct property *propn, *tprop;
  99
 100         /* NOTE: Multiple changes of single properties not supported */
 101         tprop = of_find_property(target, prop->name, NULL);
 102
 103         /* special properties are not meant to be updated (silent NOP) */
 104         if (of_prop_cmp(prop->name, "name") == 0 ||
 105             of_prop_cmp(prop->name, "phandle") == 0 ||
 106             of_prop_cmp(prop->name, "linux,phandle") == 0)
 107                 return 0;
 108
 109         propn = __of_prop_dup(prop, GFP_KERNEL);
 110         if (propn == NULL)
 111                 return -ENOMEM;
 112
 113         /* not found? add */
 114         if (tprop == NULL)
 115                 return of_changeset_add_property(&ov->cset, target, propn);
 116
 117         /* found? update */
 118         return of_changeset_update_property(&ov->cset, target, propn);
 119 }
 120
 121 static int of_overlay_apply_single_device_node(struct of_overlay *ov,
 122                 struct device_node *target, struct device_node *child)
 123 {
 124         const char *cname;
 125         struct device_node *tchild;
 126         int ret = 0;
 127
 128         cname = kbasename(child->full_name);
 129         if (cname == NULL)
 130                 return -ENOMEM;
 131
 132         /* NOTE: Multiple mods of created nodes not supported */
 133         for_each_child_of_node(target, tchild)
 134                 if (!of_node_cmp(cname, kbasename(tchild->full_name)))
 135                         break;
 136
 137         if (tchild != NULL) {
 138                 /* new overlay phandle value conflicts with existing value */
 139                 if (child->phandle)
 140                         return -EINVAL;
 141
 142                 /* apply overlay recursively */
 143                 ret = of_overlay_apply_one(ov, tchild, child);
 144                 of_node_put(tchild);
 145         } else {
 146                 /* create empty tree as a target */
 147                 tchild = __of_node_dup(child, "%pOF/%s", target, cname);
 148                 if (!tchild)
 149                         return -ENOMEM;
 150
 151                 /* point to parent */
 152                 tchild->parent = target;
 153
 154                 ret = of_changeset_attach_node(&ov->cset, tchild);
 155                 if (ret)
 156                         return ret;
 157
 158                 ret = of_overlay_apply_one(ov, tchild, child);
 159                 if (ret)
 160                         return ret;
 161         }
 162
 163         return ret;
 164 }
 165
 166 /*
 167  * Apply a single overlay node recursively.
 168  *
 169  * Note that the in case of an error the target node is left
 170  * in a inconsistent state. Error recovery should be performed
 171  * by using the changeset.
 172  */
 173 static int of_overlay_apply_one(struct of_overlay *ov,
 174                 struct device_node *target, const struct device_node *overlay)
 175 {
 176         struct device_node *child;
 177         struct property *prop;
 178         int ret;
 179
 180         for_each_property_of_node(overlay, prop) {
 181                 ret = of_overlay_apply_single_property(ov, target, prop);
 182                 if (ret) {
 183                         pr_err("Failed to apply prop @%pOF/%s\n",
 184                                target, prop->name);
 185                         return ret;
 186                 }
 187         }
 188
 189         for_each_child_of_node(overlay, child) {
 190                 ret = of_overlay_apply_single_device_node(ov, target, child);
 191                 if (ret != 0) {
 192                         pr_err("Failed to apply single node @%pOF/%s\n",
 193                                target, child->name);
 194                         of_node_put(child);
 195                         return ret;
 196                 }
 197         }
 198
 199         return 0;
 200 }
 201
 202 /**
 203  * of_overlay_apply() - Apply @count overlays pointed at by @ovinfo_tab
 204  * @ov:         Overlay to apply
 205  *
 206  * Applies the overlays given, while handling all error conditions
 207  * appropriately. Either the operation succeeds, or if it fails the
 208  * live tree is reverted to the state before the attempt.
 209  * Returns 0, or an error if the overlay attempt failed.
 210  */
 211 static int of_overlay_apply(struct of_overlay *ov)
 212 {
 213         int i, err;
 214
 215         /* first we apply the overlays atomically */
 216         for (i = 0; i < ov->count; i++) {
 217                 struct of_overlay_info *ovinfo = &ov->ovinfo_tab[i];
 218
 219                 err = of_overlay_apply_one(ov, ovinfo->target, ovinfo->overlay);
 220                 if (err != 0) {
 221                         pr_err("apply failed '%pOF'\n", ovinfo->target);
 222                         return err;
 223                 }
 224         }
 225
 226         return 0;
 227 }
 228
 229 /*
 230  * Find the target node using a number of different strategies
 231  * in order of preference
 232  *
 233  * "target" property containing the phandle of the target
 234  * "target-path" property containing the path of the target
 235  */
 236 static struct device_node *find_target_node(struct device_node *info_node)
 237 {
 238         const char *path;
 239         u32 val;
 240         int ret;
 241
 242         /* first try to go by using the target as a phandle */
 243         ret = of_property_read_u32(info_node, "target", &val);
 244         if (ret == 0)
 245                 return of_find_node_by_phandle(val);
 246
 247         /* now try to locate by path */
 248         ret = of_property_read_string(info_node, "target-path", &path);
 249         if (ret == 0)
 250                 return of_find_node_by_path(path);
 251
 252         pr_err("Failed to find target for node %p (%s)\n",
 253                 info_node, info_node->name);
 254
 255         return NULL;
 256 }
 257
 258 /**
 259  * of_fill_overlay_info() - Fill an overlay info structure
 260  * @ov          Overlay to fill
 261  * @info_node:  Device node containing the overlay
 262  * @ovinfo:     Pointer to the overlay info structure to fill
 263  *
 264  * Fills an overlay info structure with the overlay information
 265  * from a device node. This device node must have a target property
 266  * which contains a phandle of the overlay target node, and an
 267  * __overlay__ child node which has the overlay contents.
 268  * Both ovinfo->target & ovinfo->overlay have their references taken.
 269  *
 270  * Returns 0 on success, or a negative error value.
 271  */
 272 static int of_fill_overlay_info(struct of_overlay *ov,
 273                 struct device_node *info_node, struct of_overlay_info *ovinfo)
 274 {
 275         ovinfo->overlay = of_get_child_by_name(info_node, "__overlay__");
 276         if (ovinfo->overlay == NULL)
 277                 goto err_fail;
 278
 279         ovinfo->target = find_target_node(info_node);
 280         if (ovinfo->target == NULL)
 281                 goto err_fail;
 282
 283         return 0;
 284
 285 err_fail:
 286         of_node_put(ovinfo->target);
 287         of_node_put(ovinfo->overlay);
 288
 289         memset(ovinfo, 0, sizeof(*ovinfo));
 290         return -EINVAL;
 291 }
 292
 293 /**
 294  * of_build_overlay_info() - Build an overlay info array
 295  * @ov          Overlay to build
 296  * @tree:       Device node containing all the overlays
 297  *
 298  * Helper function that given a tree containing overlay information,
 299  * allocates and builds an overlay info array containing it, ready
 300  * for use using of_overlay_apply.
 301  *
 302  * Returns 0 on success with the @cntp @ovinfop pointers valid,
 303  * while on error a negative error value is returned.
 304  */
 305 static int of_build_overlay_info(struct of_overlay *ov,
 306                 struct device_node *tree)
 307 {
 308         struct device_node *node;
 309         struct of_overlay_info *ovinfo;
 310         int cnt, err;
 311
 312         /* worst case; every child is a node */
 313         cnt = 0;
 314         for_each_child_of_node(tree, node)
 315                 cnt++;
 316
 317         ovinfo = kcalloc(cnt, sizeof(*ovinfo), GFP_KERNEL);
 318         if (ovinfo == NULL)
 319                 return -ENOMEM;
 320
 321         cnt = 0;
 322         for_each_child_of_node(tree, node) {
 323                 err = of_fill_overlay_info(ov, node, &ovinfo[cnt]);
 324                 if (err == 0)
 325                         cnt++;
 326         }
 327
 328         /* if nothing filled, return error */
 329         if (cnt == 0) {
 330                 kfree(ovinfo);
 331                 return -ENODEV;
 332         }
 333
 334         ov->count = cnt;
 335         ov->ovinfo_tab = ovinfo;
 336
 337         return 0;
 338 }
 339
 340 /**
 341  * of_free_overlay_info() - Free an overlay info array
 342  * @ov          Overlay to free the overlay info from
 343  * @ovinfo_tab: Array of overlay_info's to free
 344  *
 345  * Releases the memory of a previously allocated ovinfo array
 346  * by of_build_overlay_info.
 347  * Returns 0, or an error if the arguments are bogus.
 348  */
 349 static int of_free_overlay_info(struct of_overlay *ov)
 350 {
 351         struct of_overlay_info *ovinfo;
 352         int i;
 353
 354         /* do it in reverse */
 355         for (i = ov->count - 1; i >= 0; i--) {
 356                 ovinfo = &ov->ovinfo_tab[i];
 357
 358                 of_node_put(ovinfo->target);
 359                 of_node_put(ovinfo->overlay);
 360         }
 361         kfree(ov->ovinfo_tab);
 362
 363         return 0;
 364 }
 365
 366 static int of_overlay_add_symbols(
 367                 struct device_node *tree,
 368                 struct of_overlay *ov)
 369 {
 370         struct of_overlay_info *ovinfo;
 371         struct device_node *root_sym = NULL;
 372         struct device_node *child = NULL;
 373         struct property *prop;
 374         const char *path, *s;
 375         char *new_path;
 376         int i, len, err;
 377
 378         /* both may fail (if no fixups are required) */
 379         root_sym = of_find_node_by_path("/__symbols__");
 380         child = of_get_child_by_name(tree, "__symbols__");
 381
 382         err = 0;
 383         /* do nothing if either is NULL */
 384         if (!root_sym || !child)
 385                 goto out;
 386
 387         for_each_property_of_node(child, prop) {
 388
 389                 /* skip properties added automatically */
 390                 if (of_prop_cmp(prop->name, "name") == 0)
 391                         continue;
 392
 393                 err = of_property_read_string(child,
 394                                 prop->name, &path);
 395                 if (err != 0) {
 396                         pr_err("Could not find symbol '%s'\n", prop->name);
 397                         continue;
 398                 }
 399
 400                 /* now find fragment index */
 401                 s = path;
 402
 403                 /* compare paths to find fragment index */
 404                 for (i = 0, ovinfo = NULL, len = -1; i < ov->count; i++) {
 405                         ovinfo = &ov->ovinfo_tab[i];
 406
 407                         pr_debug("#%d: overlay->name=%s target->name=%s\n",
 408                                         i, ovinfo->overlay->full_name,
 409                                         ovinfo->target->full_name);
 410
 411                         len = strlen(ovinfo->overlay->full_name);
 412                         if (strncasecmp(path, ovinfo->overlay->full_name,
 413                                                 len) == 0 && path[len] == '/')
 414                                 break;
 415                 }
 416
 417                 if (i >= ov->count)
 418                         continue;
 419
 420                 pr_debug("found target at #%d\n", i);
 421                 new_path = kasprintf(GFP_KERNEL, "%s%s",
 422                                 ovinfo->target->full_name,
 423                                 path + len);
 424                 if (!new_path) {
 425                         pr_err("Failed to allocate propname for \"%s\"\n",
 426                                         prop->name);
 427                         err = -ENOMEM;
 428                         break;
 429                 }
 430
 431                 err = of_changeset_add_property_string(&ov->cset, root_sym,
 432                                 prop->name, new_path);
 433
 434                 /* free always */
 435                 kfree(new_path);
 436
 437                 if (err) {
 438                         pr_err("Failed to add property for \"%s\"\n",
 439                                         prop->name);
 440                         break;
 441                 }
 442         }
 443
 444 out:
 445         of_node_put(child);
 446         of_node_put(root_sym);
 447
 448         return err;
 449 }
 450
 451 static LIST_HEAD(ov_list);
 452 static DEFINE_IDR(ov_idr);
 453
 454 /**
 455  * of_overlay_create() - Create and apply an overlay
 456  * @tree:       Device node containing all the overlays
 457  *
 458  * Creates and applies an overlay while also keeping track
 459  * of the overlay in a list. This list can be used to prevent
 460  * illegal overlay removals.
 461  *
 462  * Returns the id of the created overlay, or a negative error number
 463  */
 464 int of_overlay_create(struct device_node *tree)
 465 {
 466         struct of_overlay *ov;
 467         int err, id;
 468
 469         /* allocate the overlay structure */
 470         ov = kzalloc(sizeof(*ov), GFP_KERNEL);
 471         if (ov == NULL)
 472                 return -ENOMEM;
 473         ov->id = -1;
 474
 475         INIT_LIST_HEAD(&ov->node);
 476
 477         of_changeset_init(&ov->cset);
 478
 479         mutex_lock(&of_mutex);
 480
 481         id = idr_alloc(&ov_idr, ov, 0, 0, GFP_KERNEL);
 482         if (id < 0) {
 483                 err = id;
 484                 goto err_destroy_trans;
 485         }
 486         ov->id = id;
 487
 488         /* build the overlay info structures */
 489         err = of_build_overlay_info(ov, tree);
 490         if (err) {
 491                 pr_err("of_build_overlay_info() failed for tree@%pOF\n",
 492                        tree);
 493                 goto err_free_idr;
 494         }
 495
 496         err = of_overlay_notify(ov, OF_OVERLAY_PRE_APPLY);
 497         if (err < 0) {
 498                 pr_err("%s: Pre-apply notifier failed (err=%d)\n",
 499                        __func__, err);
 500                 goto err_free_idr;
 501         }
 502
 503         /* apply the overlay */
 504         err = of_overlay_apply(ov);
 505         if (err)
 506                 goto err_abort_trans;
 507
 508         err = of_overlay_add_symbols(tree, ov);
 509         if (err) {
 510                 pr_err("%s: of_overlay_add_symbols() failed for tree@%s\n",
 511                                 __func__, tree->full_name);
 512                 goto err_abort_trans;
 513         }
 514
 515         /* apply the changeset */
 516         err = __of_changeset_apply(&ov->cset);
 517         if (err)
 518                 goto err_revert_overlay;
 519
 520
 521         /* add to the tail of the overlay list */
 522         list_add_tail(&ov->node, &ov_list);
 523
 524         of_overlay_notify(ov, OF_OVERLAY_POST_APPLY);
 525
 526         mutex_unlock(&of_mutex);
 527
 528         return id;
 529
 530 err_revert_overlay:
 531 err_abort_trans:
 532         of_free_overlay_info(ov);
 533 err_free_idr:
 534         idr_remove(&ov_idr, ov->id);
 535 err_destroy_trans:
 536         of_changeset_destroy(&ov->cset);
 537         kfree(ov);
 538         mutex_unlock(&of_mutex);
 539
 540         return err;
 541 }
 542 EXPORT_SYMBOL_GPL(of_overlay_create);
 543
 544 /* check whether the given node, lies under the given tree */
 545 static int overlay_subtree_check(struct device_node *tree,
 546                 struct device_node *dn)
 547 {
 548         struct device_node *child;
 549
 550         /* match? */
 551         if (tree == dn)
 552                 return 1;
 553
 554         for_each_child_of_node(tree, child) {
 555                 if (overlay_subtree_check(child, dn)) {
 556                         of_node_put(child);
 557                         return 1;
 558                 }
 559         }
 560
 561         return 0;
 562 }
 563
 564 /* check whether this overlay is the topmost */
 565 static int overlay_is_topmost(struct of_overlay *ov, struct device_node *dn)
 566 {
 567         struct of_overlay *ovt;
 568         struct of_changeset_entry *ce;
 569
 570         list_for_each_entry_reverse(ovt, &ov_list, node) {
 571                 /* if we hit ourselves, we're done */
 572                 if (ovt == ov)
 573                         break;
 574
 575                 /* check against each subtree affected by this overlay */
 576                 list_for_each_entry(ce, &ovt->cset.entries, node) {
 577                         if (overlay_subtree_check(ce->np, dn)) {
 578                                 pr_err("%s: #%d clashes #%d @%pOF\n",
 579                                         __func__, ov->id, ovt->id, dn);
 580                                 return 0;
 581                         }
 582                 }
 583         }
 584
 585         /* overlay is topmost */
 586         return 1;
 587 }
 588
 589 /*
 590  * We can safely remove the overlay only if it's the top-most one.
 591  * Newly applied overlays are inserted at the tail of the overlay list,
 592  * so a top most overlay is the one that is closest to the tail.
 593  *
 594  * The topmost check is done by exploiting this property. For each
 595  * affected device node in the log list we check if this overlay is
 596  * the one closest to the tail. If another overlay has affected this
 597  * device node and is closest to the tail, then removal is not permited.
 598  */
 599 static int overlay_removal_is_ok(struct of_overlay *ov)
 600 {
 601         struct of_changeset_entry *ce;
 602
 603         list_for_each_entry(ce, &ov->cset.entries, node) {
 604                 if (!overlay_is_topmost(ov, ce->np)) {
 605                         pr_err("overlay #%d is not topmost\n", ov->id);
 606                         return 0;
 607                 }
 608         }
 609
 610         return 1;
 611 }
 612
 613 /**
 614  * of_overlay_destroy() - Removes an overlay
 615  * @id: Overlay id number returned by a previous call to of_overlay_create
 616  *
 617  * Removes an overlay if it is permissible.
 618  *
 619  * Returns 0 on success, or a negative error number
 620  */
 621 int of_overlay_destroy(int id)
 622 {
 623         struct of_overlay *ov;
 624         int err;
 625
 626         mutex_lock(&of_mutex);
 627
 628         ov = idr_find(&ov_idr, id);
 629         if (ov == NULL) {
 630                 err = -ENODEV;
 631                 pr_err("destroy: Could not find overlay #%d\n", id);
 632                 goto out;
 633         }
 634
 635         /* check whether the overlay is safe to remove */
 636         if (!overlay_removal_is_ok(ov)) {
 637                 err = -EBUSY;
 638                 goto out;
 639         }
 640
 641         of_overlay_notify(ov, OF_OVERLAY_PRE_REMOVE);
 642         list_del(&ov->node);
 643         __of_changeset_revert(&ov->cset);
 644         of_overlay_notify(ov, OF_OVERLAY_POST_REMOVE);
 645         of_free_overlay_info(ov);
 646         idr_remove(&ov_idr, id);
 647         of_changeset_destroy(&ov->cset);
 648         kfree(ov);
 649
 650         err = 0;
 651
 652 out:
 653         mutex_unlock(&of_mutex);
 654
 655         return err;
 656 }
 657 EXPORT_SYMBOL_GPL(of_overlay_destroy);
 658
 659 /**
 660  * of_overlay_destroy_all() - Removes all overlays from the system
 661  *
 662  * Removes all overlays from the system in the correct order.
 663  *
 664  * Returns 0 on success, or a negative error number
 665  */
 666 int of_overlay_destroy_all(void)
 667 {
 668         struct of_overlay *ov, *ovn;
 669
 670         mutex_lock(&of_mutex);
 671
 672         /* the tail of list is guaranteed to be safe to remove */
 673         list_for_each_entry_safe_reverse(ov, ovn, &ov_list, node) {
 674                 list_del(&ov->node);
 675                 __of_changeset_revert(&ov->cset);
 676                 of_free_overlay_info(ov);
 677                 idr_remove(&ov_idr, ov->id);
 678                 kfree(ov);
 679         }
 680
 681         mutex_unlock(&of_mutex);
 682
 683         return 0;
 684 }
 685 EXPORT_SYMBOL_GPL(of_overlay_destroy_all);