blob: 458f0d2d0e0d40eb2db0b8fdf7979e95df3ecedb [file] [log] [blame]
.. 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
if you want to help out.
.. toctree::
:maxdepth: 2
Unified Extensible Firmware (UEFI)
U-Boot provides an implementation of the UEFI API allowing to run UEFI
compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
can be run an UEFI payload.
.. toctree::
:maxdepth: 2
Driver-Model documentation
The following holds information on the U-Boot device driver framework:
driver-model, including the design details of itself and several driver
.. toctree::
:maxdepth: 2
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
.. toctree::
:maxdepth: 2
Architecture-specific doc
These books provide programming details about architecture-specific
.. toctree::
:maxdepth: 2
Board-specific doc
These books provide details about board-specific information. They are
organized in a vendor subdirectory.
.. toctree::
:maxdepth: 2
Indices and tables
* :ref:`genindex`