2018-07-29 11:45:47 +00:00
|
|
|
.. SPDX-License-Identifier: GPL-2.0+
|
2018-07-10 06:40:17 +00:00
|
|
|
|
2019-07-18 07:33:47 +00:00
|
|
|
.. _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
|
2018-07-10 06:40:17 +00:00
|
|
|
|
2019-10-27 12:19:45 +00:00
|
|
|
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
|
2020-12-12 07:50:37 +00:00
|
|
|
usage/index
|
2019-10-27 12:19:45 +00:00
|
|
|
|
2020-04-24 21:31:20 +00:00
|
|
|
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
|
|
|
|
|
|
2019-07-18 07:33:48 +00:00
|
|
|
|
2019-07-18 07:33:46 +00:00
|
|
|
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).
|
|
|
|
|
|
2018-07-29 11:45:47 +00:00
|
|
|
.. toctree::
|
2019-07-18 07:33:46 +00:00
|
|
|
:maxdepth: 2
|
2018-07-10 06:40:17 +00:00
|
|
|
|
2019-07-18 07:33:46 +00:00
|
|
|
api/index
|
2019-07-18 07:33:47 +00:00
|
|
|
|
2019-07-18 07:34:02 +00:00
|
|
|
Architecture-specific doc
|
|
|
|
|
-------------------------
|
|
|
|
|
|
|
|
|
|
These books provide programming details about architecture-specific
|
|
|
|
|
implementation.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
arch/index
|
|
|
|
|
|
2021-03-25 00:20:48 +00:00
|
|
|
Machine-specific doc
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
These books provide programming details about machine-specific
|
|
|
|
|
implementation.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
imx/index
|
|
|
|
|
|
2019-07-18 07:34:04 +00:00
|
|
|
Board-specific doc
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
These books provide details about board-specific information. They are
|
|
|
|
|
organized in a vendor subdirectory.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
board/index
|
|
|
|
|
|
2020-01-24 15:53:44 +00:00
|
|
|
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
|
|
|
|
|
|
2021-03-15 05:11:20 +00:00
|
|
|
Chromium OS-specific doc
|
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
chromium/index
|
|
|
|
|
|
2019-07-18 07:33:47 +00:00
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
