On Fri, Dec 22, 2023 at 07:35:57PM +0000, Alexander Graf wrote: > diff --git a/Documentation/kho/concepts.rst b/Documentation/kho/concepts.rst > new file mode 100644 > index 000000000000..8e4fe8c57865 > --- /dev/null > +++ b/Documentation/kho/concepts.rst > @@ -0,0 +1,88 @@ > +.. SPDX-License-Identifier: GPL-2.0-or-later > + > +======================= > +Kexec Handover Concepts > +======================= > + > +Kexec HandOver (KHO) is a mechanism that allows Linux to preserve state - > +arbitrary properties as well as memory locations - across kexec. > + > +It introduces multiple concepts: > + > +KHO Device Tree > +--------------- > + > +Every KHO kexec carries a KHO specific flattened device tree blob that > +describes the state of the system. Device drivers can register to KHO to > +serialize their state before kexec. After KHO, device drivers can read > +the device tree and extract previous state. > + > +KHO only uses the fdt container format and libfdt library, but does not > +adhere to the same property semantics that normal device trees do: Properties > +are passed in native endianness and standardized properties like ``regs`` and > +``ranges`` do not exist, hence there are no ``#...-cells`` properties. > + > +KHO introduces a new concept to its device tree: ``mem`` properties. A > +``mem`` property can inside any subnode in the device tree. When present, Should it be "property can be" ? ... > diff --git a/Documentation/kho/usage.rst b/Documentation/kho/usage.rst > new file mode 100644 > index 000000000000..5efa2a58f9c3 > --- /dev/null > +++ b/Documentation/kho/usage.rst > @@ -0,0 +1,57 @@ > +.. SPDX-License-Identifier: GPL-2.0-or-later > + > +==================== > +Kexec Handover Usage > +==================== > + > +Kexec HandOver (KHO) is a mechanism that allows Linux to preserve state - > +arbitrary properties as well as memory locations - across kexec. > + > +This document expects that you are familiar with the base KHO > +:ref:`Documentation/kho/concepts.rst <concepts>`. If you have not read > +them yet, please do so now. > + > +Prerequisites > +------------- > + > +KHO is available when the ``CONFIG_KEXEC_KHO`` config option is set to y > +at compile team. Every KHO producer has its own config option that you Should it be "at compile time."?
