of_overlay_fdt_apply(9)

okay so this is of_overlay_fdt_apply(9) from the Kernel API Manual, and bestie, it's literally the “create and apply an overlay changeset” function. 🦋✨

💖 NAME 💖

of_overlay_fdt_apply - Create and apply an overlay changeset

✨ SYNOPSIS ✨

       int of_overlay_fdt_apply (const void *overlay_fdt , u32 overlay_fdt_size
       , int *ret_ovcs_id , const struct device_node *base );

🎀 ARGUMENTS 🎀

• overlay_fdt — pointer to overlay FDT
• overlay_fdt_size — number of bytes in overlay_fdt
• ret_ovcs_id — pointer for returning created changeset id
• base — pointer for the target node to apply overlay

🦋 DESCRIPTION 🦋

Creates and applies an overlay changeset. 💅

See of_overlay_apply for important behavior information. fr fr, that one matters.

On error return, the changeset may be partially applied 😭. This is especially likely if an OF_OVERLAY_POST_APPLY notifier returns an error. In this case the caller should call of_overlay_remove with the value in *ret_ovcs_id.

🔥 RETURN 🔥

• 0 on success, or a negative error number.
• *ret_ovcs_id is set to the value of overlay changeset id, which can be passed to of_overlay_remove to remove the overlay.

🌈 SEE ALSO 🌈

Kernel file ./drivers/of/overlay.c, plus the whole squad:

• struct target(9)
• struct fragment(9)
• struct overlay_changeset(9)
• of_overlay_notifier_register(9)
• of_overlay_notifier_unregister(9)
• add_changeset_property(9)
• add_changeset_node(9)
• build_changeset_next_level(9)
• changeset_dup_entry_check(9)
• build_changeset(9)
• init_overlay_changeset(9)
• of_overlay_remove(9)
• of_overlay_remove_all(9)

cute little sign-off bestie: source/version ./drivers/of, date October 2026, and this whole page is giving Kernel API Manual energy 🫶✨💅