mirror of
https://github.com/brain-hackers/u-boot-brain
synced 2024-06-09 23:36:03 +09:00
59e3d1bd49
Document SRC_GPR10 PERSIST_SECONDARY_BOOT functionality. This is useful for reliable bootloader A/B updates, as it permits switching between two copies of bootloader at different offsets of the same storage. The switch happens in case one copy is corrupted OR can be enforced by user. This functionality is present at least since i.MX53, however is poorly documented in all known SoC datasheets, hence this document aims to clarify the usage, currently on i.MX7D and i.MX8MM. Signed-off-by: Marek Vasut <marex@denx.de> # Original MX7D work, this document Signed-off-by: Igor Opaniuk <igor.opaniuk@foundries.io> # All the MX8M work Cc: Christoph Niedermaier <cniedermaier@dh-electronics.de> Cc: Fabio Estevam <festevam@gmail.com> Cc: Harald Seiler <hws@denx.de> Cc: Igor Opaniuk <igor.opaniuk@foundries.io> Cc: Jan Kiszka <jan.kiszka@siemens.com> Cc: Ludwig Zenz <lzenz@dh-electronics.com> Cc: Marcel Ziswiler <marcel.ziswiler@toradex.com> Cc: Peng Fan <peng.fan@nxp.com> Cc: Stefano Babic <sbabic@denx.de> Cc: Ye Li <ye.li@nxp.com> Cc: uboot-imx <uboot-imx@nxp.com> Reviewed-by: Peng Fan <peng.fan@nxp.com>
113 lines
2.3 KiB
ReStructuredText
113 lines
2.3 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0+
|
|
|
|
.. _u-boot_doc:
|
|
|
|
The U-Boot Documentation
|
|
========================
|
|
|
|
This is the top level of the U-Boot's documentation tree. U-Boot
|
|
documentation, like the U-Boot itself, is very much a work in progress;
|
|
that is especially true as we work to integrate our many scattered
|
|
documents into a coherent whole. Please note that improvements to the
|
|
documentation are welcome; join the U-Boot list at http://lists.denx.de
|
|
if you want to help out.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
User-oriented documentation
|
|
---------------------------
|
|
|
|
The following manuals are written for *users* of the U-Boot - those who are
|
|
trying to get it to work optimally on a given system.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
build/index
|
|
usage/index
|
|
|
|
Developer-oriented documentation
|
|
--------------------------------
|
|
|
|
The following manuals are written for *developers* of the U-Boot - those who
|
|
want to contribute to U-Boot.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
develop/index
|
|
|
|
|
|
U-Boot API documentation
|
|
------------------------
|
|
|
|
These books get into the details of how specific U-Boot subsystems work
|
|
from the point of view of a U-Boot developer. Much of the information here
|
|
is taken directly from the U-Boot source, with supplemental material added
|
|
as needed (or at least as we managed to add it - probably *not* all that is
|
|
needed).
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api/index
|
|
|
|
Architecture-specific doc
|
|
-------------------------
|
|
|
|
These books provide programming details about architecture-specific
|
|
implementation.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
arch/index
|
|
|
|
Machine-specific doc
|
|
--------------------
|
|
|
|
These books provide programming details about machine-specific
|
|
implementation.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
imx/index
|
|
|
|
Board-specific doc
|
|
------------------
|
|
|
|
These books provide details about board-specific information. They are
|
|
organized in a vendor subdirectory.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
board/index
|
|
|
|
Android-specific doc
|
|
--------------------
|
|
|
|
These books provide information about booting the Android OS from U-Boot,
|
|
manipulating Android images from U-Boot shell and discusses other
|
|
Android-specific features available in U-Boot.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
android/index
|
|
|
|
Chromium OS-specific doc
|
|
------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
chromium/index
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|