9 #define pr_fmt(fmt)	"OF: overlay: " fmt
27  * struct target - info about current target node as recursing through overlay
28  * @np:			node where current level of overlay will be applied
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
47  * struct fragment - info about fragment nodes in overlay expanded device tree
48  * @target:	target of the overlay operation
49  * @overlay:	pointer to the __overlay__ node
52 	struct device_node *overlay;  member
63  * @fragments:		fragment nodes in the overlay expanded device tree
125  * of_overlay_notifier_register() - Register notifier for overlay operations
128  * Register for notification on overlay operations on device tree nodes. The
143  * of_overlay_notifier_register() - Unregister notifier for overlay operations
169 		nd.overlay = fragment->overlay;  in overlay_notify()
175 			pr_err("overlay changeset %s notifier error %d, target: %pOF\n",  in overlay_notify()
229 		if (fragment->overlay == overlay_node)  in dup_and_fixup_symbol_prop()
235 	overlay_name_len = snprintf(NULL, 0, "%pOF", fragment->overlay);  in dup_and_fixup_symbol_prop()
277  * add_changeset_property() - add @overlay_prop to overlay changeset
278  * @ovcs:		overlay changeset
280  * @overlay_prop:	property to add or update, from overlay tree
295  * in the overlay must match the values in the live tree.
300  * invalid @overlay.
363 		pr_err("WARNING: memory leak will occur if overlay removed, property: %pOF/%s\n",  in add_changeset_property()
375  * add_changeset_node() - add @node (and children) to overlay changeset
376  * @ovcs:	overlay changeset
378  * @node:	node from within overlay device tree fragment
384  * a phandle, the overlay node is not allowed to have a phandle.
390  *       not contain the full path in node->full_name.  Thus an overlay
396  *       the full path in node->full_name.  Even though it expects the overlay
399  *       to nodes in the live devicetree so that it can apply an overlay to
405  * invalid @overlay.
465  * build_changeset_next_level() - add level of overlay changeset
466  * @ovcs:		overlay changeset
468  * @overlay_node:	node from within an overlay device tree fragment
601  * @ovcs:	Overlay changeset
623  * build_changeset() - populate overlay changeset in @ovcs from @ovcs->fragments
624  * @ovcs:	Overlay changeset
627  * overlay device tree fragments in @ovcs->fragments[].  If an error occurs,
632  * invalid overlay in @ovcs->fragments[].
655 						 fragment->overlay);  in build_changeset()
669 						   fragment->overlay);  in build_changeset()
718  * init_overlay_changeset() - initialize overlay changeset from overlay tree
719  * @ovcs:	Overlay changeset to build
721  * @tree:	Contains all the overlay fragments and overlay fixup nodes
792 		fragment->overlay = overlay_node;  in init_overlay_changeset()
795 			of_node_put(fragment->overlay);  in init_overlay_changeset()
812 		fragment->overlay = node;  in init_overlay_changeset()
816 			pr_err("symbols in overlay, but not in live tree\n");  in init_overlay_changeset()
825 		pr_err("no fragments or symbols in overlay\n");  in init_overlay_changeset()
858 		of_node_put(ovcs->fragments[i].overlay);  in free_overlay_changeset()
863 	 * ovcs->fdt due to the policy that overlay notifiers are not allowed  in free_overlay_changeset()
864 	 * to retain pointers into the overlay devicetree.  in free_overlay_changeset()
874  * of_overlay_apply() - Create and apply an overlay changeset
876  * @tree:	Expanded overlay device tree
877  * @ovcs_id:	Pointer to overlay changeset id
879  * Creates and applies an overlay changeset.
888  *   - overlay changeset pre-apply notifier
890  * If an error is returned by an overlay changeset pre-apply notifier
891  * then no further overlay changeset pre-apply notifier will be called.
894  *   - overlay changeset entry notifier
895  *   - overlay changeset post-apply notifier
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.
903  * If an error occurred while applying the overlay changeset, then an
907  * following attempt to apply or remove an overlay changeset will be
910  * Returns 0 on success, or a negative error number.  Overlay changeset
921 	 * As of this point, fdt and tree belong to the overlay changeset.  in of_overlay_apply()
922 	 * overlay changeset code is responsible for freeing them.  in of_overlay_apply()
926 		pr_err("devicetree state suspect, refuse to apply overlay\n");  in of_overlay_apply()
959 		pr_err("overlay changeset pre-apply notify error %d\n", ret);  in of_overlay_apply()
971 			pr_debug("overlay changeset revert error %d\n",  in of_overlay_apply()
980 		pr_err("overlay apply changeset entry notify error %d\n", ret);  in of_overlay_apply()
988 		pr_err("overlay changeset post-apply notify error %d\n",  in of_overlay_apply()
1052 		 * new_fdt and overlay_root now belong to the overlay  in of_overlay_fdt_apply()
1054 		 * overlay changeset code is responsible for freeing them.  in of_overlay_fdt_apply()
1094  * node in an overlay changeset more topmost than @remove_ovcs?
1128  * We can safely remove the overlay only if it's the top-most one.
1129  * Newly applied overlays are inserted at the tail of the overlay list,
1130  * so a top most overlay is the one that is closest to the tail.
1133  * affected device node in the log list we check if this overlay is
1134  * the one closest to the tail. If another overlay has affected this
1143 			pr_err("overlay #%d is not topmost\n", remove_ovcs->id);  in overlay_removal_is_ok()
1152  * of_overlay_remove() - Revert and free an overlay changeset
1153  * @ovcs_id:	Pointer to overlay changeset id
1155  * Removes an overlay if it is permissible.  @ovcs_id was previously returned
1158  * If an error occurred while attempting to revert the overlay changeset,
1162  * an overlay changeset will be refused.
1166  *   - overlay changeset pre-remove notifier
1167  *   - overlay changeset entry revert
1169  * If an error is returned by an overlay changeset pre-remove notifier
1170  * then no further overlay changeset pre-remove notifier will be called.
1176  *   - overlay changeset entry notifier
1177  *   - overlay changeset post-remove notifier
1179  * If an error is returned by an overlay changeset post-remove notifier
1180  * then no further overlay changeset post-remove notifier will be called.
1193 		pr_err("suspect devicetree state, refuse to remove overlay\n");  in of_overlay_remove()
1203 		pr_err("remove: Could not find overlay #%d\n", *ovcs_id);  in of_overlay_remove()
1214 		pr_err("overlay changeset pre-remove notify error %d\n", ret);  in of_overlay_remove()
1230 		pr_err("overlay remove changeset entry notify error %d\n", ret);  in of_overlay_remove()
1237 		pr_err("overlay changeset post-remove notify error %d\n",  in of_overlay_remove()
1256  * of_overlay_remove_all() - Reverts and frees all overlay changesets