| /* |
| * Functions for working with device tree overlays |
| * |
| * Copyright (C) 2012 Pantelis Antoniou <panto@antoniou-consulting.com> |
| * Copyright (C) 2012 Texas Instruments Inc. |
| * |
| * This program is free software; you can redistribute it and/or |
| * modify it under the terms of the GNU General Public License |
| * version 2 as published by the Free Software Foundation. |
| */ |
| |
| #define pr_fmt(fmt) "OF: overlay: " fmt |
| |
| #include <linux/kernel.h> |
| #include <linux/module.h> |
| #include <linux/of.h> |
| #include <linux/of_device.h> |
| #include <linux/string.h> |
| #include <linux/ctype.h> |
| #include <linux/errno.h> |
| #include <linux/slab.h> |
| #include <linux/err.h> |
| #include <linux/idr.h> |
| |
| #include "of_private.h" |
| |
| /** |
| * struct of_overlay_info - Holds a single overlay info |
| * @target: target of the overlay operation |
| * @overlay: pointer to the overlay contents node |
| * |
| * Holds a single overlay state, including all the overlay logs & |
| * records. |
| */ |
| struct of_overlay_info { |
| struct device_node *target; |
| struct device_node *overlay; |
| bool is_symbols_node; |
| }; |
| |
| /** |
| * struct of_overlay - Holds a complete overlay transaction |
| * @node: List on which we are located |
| * @count: Count of ovinfo structures |
| * @ovinfo_tab: Overlay info table (count sized) |
| * @cset: Changeset to be used |
| * |
| * Holds a complete overlay transaction |
| */ |
| struct of_overlay { |
| int id; |
| struct list_head node; |
| int count; |
| struct of_overlay_info *ovinfo_tab; |
| struct of_changeset cset; |
| }; |
| |
| static int of_overlay_apply_one(struct of_overlay *ov, |
| struct device_node *target, const struct device_node *overlay, |
| bool is_symbols_node); |
| |
| static BLOCKING_NOTIFIER_HEAD(of_overlay_chain); |
| |
| int of_overlay_notifier_register(struct notifier_block *nb) |
| { |
| return blocking_notifier_chain_register(&of_overlay_chain, nb); |
| } |
| EXPORT_SYMBOL_GPL(of_overlay_notifier_register); |
| |
| int of_overlay_notifier_unregister(struct notifier_block *nb) |
| { |
| return blocking_notifier_chain_unregister(&of_overlay_chain, nb); |
| } |
| EXPORT_SYMBOL_GPL(of_overlay_notifier_unregister); |
| |
| static int of_overlay_notify(struct of_overlay *ov, |
| enum of_overlay_notify_action action) |
| { |
| struct of_overlay_notify_data nd; |
| int i, ret; |
| |
| for (i = 0; i < ov->count; i++) { |
| struct of_overlay_info *ovinfo = &ov->ovinfo_tab[i]; |
| |
| nd.target = ovinfo->target; |
| nd.overlay = ovinfo->overlay; |
| |
| ret = blocking_notifier_call_chain(&of_overlay_chain, |
| action, &nd); |
| if (ret) |
| return notifier_to_errno(ret); |
| } |
| |
| return 0; |
| } |
| |
| static struct property *dup_and_fixup_symbol_prop(struct of_overlay *ov, |
| const struct property *prop) |
| { |
| struct of_overlay_info *ovinfo; |
| struct property *new; |
| const char *overlay_name; |
| char *label_path; |
| char *symbol_path; |
| const char *target_path; |
| int k; |
| int label_path_len; |
| int overlay_name_len; |
| int target_path_len; |
| |
| if (!prop->value) |
| return NULL; |
| symbol_path = prop->value; |
| |
| new = kzalloc(sizeof(*new), GFP_KERNEL); |
| if (!new) |
| return NULL; |
| |
| for (k = 0; k < ov->count; k++) { |
| ovinfo = &ov->ovinfo_tab[k]; |
| overlay_name = ovinfo->overlay->full_name; |
| overlay_name_len = strlen(overlay_name); |
| if (!strncasecmp(symbol_path, overlay_name, overlay_name_len)) |
| break; |
| } |
| |
| if (k >= ov->count) |
| goto err_free; |
| |
| target_path = ovinfo->target->full_name; |
| target_path_len = strlen(target_path); |
| |
| label_path = symbol_path + overlay_name_len; |
| label_path_len = strlen(label_path); |
| |
| new->name = kstrdup(prop->name, GFP_KERNEL); |
| new->length = target_path_len + label_path_len + 1; |
| new->value = kzalloc(new->length, GFP_KERNEL); |
| |
| if (!new->name || !new->value) |
| goto err_free; |
| |
| strcpy(new->value, target_path); |
| strcpy(new->value + target_path_len, label_path); |
| |
| /* mark the property as dynamic */ |
| of_property_set_flag(new, OF_DYNAMIC); |
| |
| return new; |
| |
| err_free: |
| kfree(new->name); |
| kfree(new->value); |
| kfree(new); |
| return NULL; |
| |
| |
| } |
| |
| static int of_overlay_apply_single_property(struct of_overlay *ov, |
| struct device_node *target, struct property *prop, |
| bool is_symbols_node) |
| { |
| struct property *propn = NULL, *tprop; |
| |
| /* NOTE: Multiple changes of single properties not supported */ |
| tprop = of_find_property(target, prop->name, NULL); |
| |
| /* special properties are not meant to be updated (silent NOP) */ |
| if (of_prop_cmp(prop->name, "name") == 0 || |
| of_prop_cmp(prop->name, "phandle") == 0 || |
| of_prop_cmp(prop->name, "linux,phandle") == 0) |
| return 0; |
| |
| if (is_symbols_node) { |
| /* changing a property in __symbols__ node not allowed */ |
| if (tprop) |
| return -EINVAL; |
| propn = dup_and_fixup_symbol_prop(ov, prop); |
| } else { |
| propn = __of_prop_dup(prop, GFP_KERNEL); |
| } |
| |
| if (propn == NULL) |
| return -ENOMEM; |
| |
| /* not found? add */ |
| if (tprop == NULL) |
| return of_changeset_add_property(&ov->cset, target, propn); |
| |
| /* found? update */ |
| return of_changeset_update_property(&ov->cset, target, propn); |
| } |
| |
| static int of_overlay_apply_single_device_node(struct of_overlay *ov, |
| struct device_node *target, struct device_node *child) |
| { |
| const char *cname; |
| struct device_node *tchild; |
| int ret = 0; |
| |
| cname = kbasename(child->full_name); |
| if (cname == NULL) |
| return -ENOMEM; |
| |
| /* NOTE: Multiple mods of created nodes not supported */ |
| for_each_child_of_node(target, tchild) |
| if (!of_node_cmp(cname, kbasename(tchild->full_name))) |
| break; |
| |
| if (tchild != NULL) { |
| /* new overlay phandle value conflicts with existing value */ |
| if (child->phandle) |
| return -EINVAL; |
| |
| /* apply overlay recursively */ |
| ret = of_overlay_apply_one(ov, tchild, child, 0); |
| of_node_put(tchild); |
| } else { |
| /* create empty tree as a target */ |
| tchild = __of_node_dup(child, "%pOF/%s", target, cname); |
| if (!tchild) |
| return -ENOMEM; |
| |
| /* point to parent */ |
| tchild->parent = target; |
| |
| ret = of_changeset_attach_node(&ov->cset, tchild); |
| if (ret) |
| return ret; |
| |
| ret = of_overlay_apply_one(ov, tchild, child, 0); |
| if (ret) |
| return ret; |
| } |
| |
| return ret; |
| } |
| |
| /* |
| * Apply a single overlay node recursively. |
| * |
| * Note that the in case of an error the target node is left |
| * in a inconsistent state. Error recovery should be performed |
| * by using the changeset. |
| */ |
| static int of_overlay_apply_one(struct of_overlay *ov, |
| struct device_node *target, const struct device_node *overlay, |
| bool is_symbols_node) |
| { |
| struct device_node *child; |
| struct property *prop; |
| int ret; |
| |
| for_each_property_of_node(overlay, prop) { |
| ret = of_overlay_apply_single_property(ov, target, prop, |
| is_symbols_node); |
| if (ret) { |
| pr_err("Failed to apply prop @%pOF/%s\n", |
| target, prop->name); |
| return ret; |
| } |
| } |
| |
| /* do not allow symbols node to have any children */ |
| if (is_symbols_node) |
| return 0; |
| |
| for_each_child_of_node(overlay, child) { |
| ret = of_overlay_apply_single_device_node(ov, target, child); |
| if (ret != 0) { |
| pr_err("Failed to apply single node @%pOF/%s\n", |
| target, child->name); |
| of_node_put(child); |
| return ret; |
| } |
| } |
| |
| return 0; |
| } |
| |
| /** |
| * of_overlay_apply() - Apply @count overlays pointed at by @ovinfo_tab |
| * @ov: Overlay to apply |
| * |
| * Applies the overlays given, while handling all error conditions |
| * appropriately. Either the operation succeeds, or if it fails the |
| * live tree is reverted to the state before the attempt. |
| * Returns 0, or an error if the overlay attempt failed. |
| */ |
| static int of_overlay_apply(struct of_overlay *ov) |
| { |
| int i, err; |
| |
| /* first we apply the overlays atomically */ |
| for (i = 0; i < ov->count; i++) { |
| struct of_overlay_info *ovinfo = &ov->ovinfo_tab[i]; |
| |
| err = of_overlay_apply_one(ov, ovinfo->target, ovinfo->overlay, |
| ovinfo->is_symbols_node); |
| if (err != 0) { |
| pr_err("apply failed '%pOF'\n", ovinfo->target); |
| return err; |
| } |
| } |
| |
| return 0; |
| } |
| |
| /* |
| * Find the target node using a number of different strategies |
| * in order of preference |
| * |
| * "target" property containing the phandle of the target |
| * "target-path" property containing the path of the target |
| */ |
| static struct device_node *find_target_node(struct device_node *info_node) |
| { |
| const char *path; |
| u32 val; |
| int ret; |
| |
| /* first try to go by using the target as a phandle */ |
| ret = of_property_read_u32(info_node, "target", &val); |
| if (ret == 0) |
| return of_find_node_by_phandle(val); |
| |
| /* now try to locate by path */ |
| ret = of_property_read_string(info_node, "target-path", &path); |
| if (ret == 0) |
| return of_find_node_by_path(path); |
| |
| pr_err("Failed to find target for node %p (%s)\n", |
| info_node, info_node->name); |
| |
| return NULL; |
| } |
| |
| /** |
| * of_fill_overlay_info() - Fill an overlay info structure |
| * @ov Overlay to fill |
| * @info_node: Device node containing the overlay |
| * @ovinfo: Pointer to the overlay info structure to fill |
| * |
| * Fills an overlay info structure with the overlay information |
| * from a device node. This device node must have a target property |
| * which contains a phandle of the overlay target node, and an |
| * __overlay__ child node which has the overlay contents. |
| * Both ovinfo->target & ovinfo->overlay have their references taken. |
| * |
| * Returns 0 on success, or a negative error value. |
| */ |
| static int of_fill_overlay_info(struct of_overlay *ov, |
| struct device_node *info_node, struct of_overlay_info *ovinfo) |
| { |
| ovinfo->overlay = of_get_child_by_name(info_node, "__overlay__"); |
| if (ovinfo->overlay == NULL) |
| goto err_fail; |
| |
| ovinfo->target = find_target_node(info_node); |
| if (ovinfo->target == NULL) |
| goto err_fail; |
| |
| return 0; |
| |
| err_fail: |
| of_node_put(ovinfo->target); |
| of_node_put(ovinfo->overlay); |
| |
| memset(ovinfo, 0, sizeof(*ovinfo)); |
| return -EINVAL; |
| } |
| |
| /** |
| * of_build_overlay_info() - Build an overlay info array |
| * @ov Overlay to build |
| * @tree: Device node containing all the overlays |
| * |
| * Helper function that given a tree containing overlay information, |
| * allocates and builds an overlay info array containing it, ready |
| * for use using of_overlay_apply. |
| * |
| * Returns 0 on success with the @cntp @ovinfop pointers valid, |
| * while on error a negative error value is returned. |
| */ |
| static int of_build_overlay_info(struct of_overlay *ov, |
| struct device_node *tree) |
| { |
| struct device_node *node; |
| struct of_overlay_info *ovinfo; |
| int cnt, err; |
| |
| /* worst case; every child is a node */ |
| cnt = 0; |
| for_each_child_of_node(tree, node) |
| cnt++; |
| |
| if (of_get_child_by_name(tree, "__symbols__")) |
| cnt++; |
| |
| ovinfo = kcalloc(cnt, sizeof(*ovinfo), GFP_KERNEL); |
| if (ovinfo == NULL) |
| return -ENOMEM; |
| |
| cnt = 0; |
| for_each_child_of_node(tree, node) { |
| err = of_fill_overlay_info(ov, node, &ovinfo[cnt]); |
| if (err == 0) |
| cnt++; |
| } |
| |
| node = of_get_child_by_name(tree, "__symbols__"); |
| if (node) { |
| ovinfo[cnt].overlay = node; |
| ovinfo[cnt].target = of_find_node_by_path("/__symbols__"); |
| ovinfo[cnt].is_symbols_node = 1; |
| |
| if (!ovinfo[cnt].target) { |
| pr_err("no symbols in root of device tree.\n"); |
| return -EINVAL; |
| } |
| |
| cnt++; |
| } |
| |
| /* if nothing filled, return error */ |
| if (cnt == 0) { |
| kfree(ovinfo); |
| return -ENODEV; |
| } |
| |
| ov->count = cnt; |
| ov->ovinfo_tab = ovinfo; |
| |
| return 0; |
| } |
| |
| /** |
| * of_free_overlay_info() - Free an overlay info array |
| * @ov Overlay to free the overlay info from |
| * @ovinfo_tab: Array of overlay_info's to free |
| * |
| * Releases the memory of a previously allocated ovinfo array |
| * by of_build_overlay_info. |
| * Returns 0, or an error if the arguments are bogus. |
| */ |
| static int of_free_overlay_info(struct of_overlay *ov) |
| { |
| struct of_overlay_info *ovinfo; |
| int i; |
| |
| /* do it in reverse */ |
| for (i = ov->count - 1; i >= 0; i--) { |
| ovinfo = &ov->ovinfo_tab[i]; |
| |
| of_node_put(ovinfo->target); |
| of_node_put(ovinfo->overlay); |
| } |
| kfree(ov->ovinfo_tab); |
| |
| return 0; |
| } |
| |
| static LIST_HEAD(ov_list); |
| static DEFINE_IDR(ov_idr); |
| |
| /** |
| * of_overlay_create() - Create and apply an overlay |
| * @tree: Device node containing all the overlays |
| * |
| * Creates and applies an overlay while also keeping track |
| * of the overlay in a list. This list can be used to prevent |
| * illegal overlay removals. |
| * |
| * Returns the id of the created overlay, or a negative error number |
| */ |
| int of_overlay_create(struct device_node *tree) |
| { |
| struct of_overlay *ov; |
| int err, id; |
| |
| /* allocate the overlay structure */ |
| ov = kzalloc(sizeof(*ov), GFP_KERNEL); |
| if (ov == NULL) |
| return -ENOMEM; |
| ov->id = -1; |
| |
| INIT_LIST_HEAD(&ov->node); |
| |
| of_changeset_init(&ov->cset); |
| |
| mutex_lock(&of_mutex); |
| |
| id = idr_alloc(&ov_idr, ov, 0, 0, GFP_KERNEL); |
| if (id < 0) { |
| err = id; |
| goto err_destroy_trans; |
| } |
| ov->id = id; |
| |
| /* build the overlay info structures */ |
| err = of_build_overlay_info(ov, tree); |
| if (err) { |
| pr_err("of_build_overlay_info() failed for tree@%pOF\n", |
| tree); |
| goto err_free_idr; |
| } |
| |
| err = of_overlay_notify(ov, OF_OVERLAY_PRE_APPLY); |
| if (err < 0) { |
| pr_err("%s: Pre-apply notifier failed (err=%d)\n", |
| __func__, err); |
| goto err_free_idr; |
| } |
| |
| /* apply the overlay */ |
| err = of_overlay_apply(ov); |
| if (err) |
| goto err_abort_trans; |
| |
| /* apply the changeset */ |
| err = __of_changeset_apply(&ov->cset); |
| if (err) |
| goto err_revert_overlay; |
| |
| |
| /* add to the tail of the overlay list */ |
| list_add_tail(&ov->node, &ov_list); |
| |
| of_overlay_notify(ov, OF_OVERLAY_POST_APPLY); |
| |
| mutex_unlock(&of_mutex); |
| |
| return id; |
| |
| err_revert_overlay: |
| err_abort_trans: |
| of_free_overlay_info(ov); |
| err_free_idr: |
| idr_remove(&ov_idr, ov->id); |
| err_destroy_trans: |
| of_changeset_destroy(&ov->cset); |
| kfree(ov); |
| mutex_unlock(&of_mutex); |
| |
| return err; |
| } |
| EXPORT_SYMBOL_GPL(of_overlay_create); |
| |
| /* check whether the given node, lies under the given tree */ |
| static int overlay_subtree_check(struct device_node *tree, |
| struct device_node *dn) |
| { |
| struct device_node *child; |
| |
| /* match? */ |
| if (tree == dn) |
| return 1; |
| |
| for_each_child_of_node(tree, child) { |
| if (overlay_subtree_check(child, dn)) { |
| of_node_put(child); |
| return 1; |
| } |
| } |
| |
| return 0; |
| } |
| |
| /* check whether this overlay is the topmost */ |
| static int overlay_is_topmost(struct of_overlay *ov, struct device_node *dn) |
| { |
| struct of_overlay *ovt; |
| struct of_changeset_entry *ce; |
| |
| list_for_each_entry_reverse(ovt, &ov_list, node) { |
| /* if we hit ourselves, we're done */ |
| if (ovt == ov) |
| break; |
| |
| /* check against each subtree affected by this overlay */ |
| list_for_each_entry(ce, &ovt->cset.entries, node) { |
| if (overlay_subtree_check(ce->np, dn)) { |
| pr_err("%s: #%d clashes #%d @%pOF\n", |
| __func__, ov->id, ovt->id, dn); |
| return 0; |
| } |
| } |
| } |
| |
| /* overlay is topmost */ |
| return 1; |
| } |
| |
| /* |
| * We can safely remove the overlay only if it's the top-most one. |
| * Newly applied overlays are inserted at the tail of the overlay list, |
| * so a top most overlay is the one that is closest to the tail. |
| * |
| * The topmost check is done by exploiting this property. For each |
| * affected device node in the log list we check if this overlay is |
| * the one closest to the tail. If another overlay has affected this |
| * device node and is closest to the tail, then removal is not permited. |
| */ |
| static int overlay_removal_is_ok(struct of_overlay *ov) |
| { |
| struct of_changeset_entry *ce; |
| |
| list_for_each_entry(ce, &ov->cset.entries, node) { |
| if (!overlay_is_topmost(ov, ce->np)) { |
| pr_err("overlay #%d is not topmost\n", ov->id); |
| return 0; |
| } |
| } |
| |
| return 1; |
| } |
| |
| /** |
| * of_overlay_destroy() - Removes an overlay |
| * @id: Overlay id number returned by a previous call to of_overlay_create |
| * |
| * Removes an overlay if it is permissible. |
| * |
| * Returns 0 on success, or a negative error number |
| */ |
| int of_overlay_destroy(int id) |
| { |
| struct of_overlay *ov; |
| int err; |
| |
| mutex_lock(&of_mutex); |
| |
| ov = idr_find(&ov_idr, id); |
| if (ov == NULL) { |
| err = -ENODEV; |
| pr_err("destroy: Could not find overlay #%d\n", id); |
| goto out; |
| } |
| |
| /* check whether the overlay is safe to remove */ |
| if (!overlay_removal_is_ok(ov)) { |
| err = -EBUSY; |
| goto out; |
| } |
| |
| of_overlay_notify(ov, OF_OVERLAY_PRE_REMOVE); |
| list_del(&ov->node); |
| __of_changeset_revert(&ov->cset); |
| of_overlay_notify(ov, OF_OVERLAY_POST_REMOVE); |
| of_free_overlay_info(ov); |
| idr_remove(&ov_idr, id); |
| of_changeset_destroy(&ov->cset); |
| kfree(ov); |
| |
| err = 0; |
| |
| out: |
| mutex_unlock(&of_mutex); |
| |
| return err; |
| } |
| EXPORT_SYMBOL_GPL(of_overlay_destroy); |
| |
| /** |
| * of_overlay_destroy_all() - Removes all overlays from the system |
| * |
| * Removes all overlays from the system in the correct order. |
| * |
| * Returns 0 on success, or a negative error number |
| */ |
| int of_overlay_destroy_all(void) |
| { |
| struct of_overlay *ov, *ovn; |
| |
| mutex_lock(&of_mutex); |
| |
| /* the tail of list is guaranteed to be safe to remove */ |
| list_for_each_entry_safe_reverse(ov, ovn, &ov_list, node) { |
| list_del(&ov->node); |
| __of_changeset_revert(&ov->cset); |
| of_free_overlay_info(ov); |
| idr_remove(&ov_idr, ov->id); |
| kfree(ov); |
| } |
| |
| mutex_unlock(&of_mutex); |
| |
| return 0; |
| } |
| EXPORT_SYMBOL_GPL(of_overlay_destroy_all); |