1.. SPDX-License-Identifier: GPL-2.0+
2
3.. _u-boot_doc:
4
5The U-Boot Documentation
6========================
7
8This is the top level of the U-Boot's documentation tree.  U-Boot
9documentation, like the U-Boot itself, is very much a work in progress;
10that is especially true as we work to integrate our many scattered
11documents into a coherent whole.  Please note that improvements to the
12documentation are welcome; join the U-Boot list at http://lists.denx.de
13if you want to help out.
14
15.. toctree::
16   :maxdepth: 2
17
18User-oriented documentation
19---------------------------
20
21The following manuals are written for *users* of the U-Boot - those who are
22trying to get it to work optimally on a given system.
23
24.. toctree::
25   :maxdepth: 2
26
27   build/index
28   usage/index
29
30Developer-oriented documentation
31--------------------------------
32
33The following manuals are written for *developers* of the U-Boot - those who
34want to contribute to U-Boot.
35
36.. toctree::
37   :maxdepth: 2
38
39   develop/index
40
41Unified Extensible Firmware (UEFI)
42----------------------------------
43
44U-Boot provides an implementation of the UEFI API allowing to run UEFI
45compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
46can be run an UEFI payload.
47
48.. toctree::
49   :maxdepth: 2
50
51   uefi/index
52
53Driver-Model documentation
54--------------------------
55
56The following holds information on the U-Boot device driver framework:
57driver-model, including the design details of itself and several driver
58subsystems.
59
60.. toctree::
61   :maxdepth: 2
62
63   driver-model/index
64
65U-Boot API documentation
66------------------------
67
68These books get into the details of how specific U-Boot subsystems work
69from the point of view of a U-Boot developer.  Much of the information here
70is taken directly from the U-Boot source, with supplemental material added
71as needed (or at least as we managed to add it - probably *not* all that is
72needed).
73
74.. toctree::
75   :maxdepth: 2
76
77   api/index
78
79Architecture-specific doc
80-------------------------
81
82These books provide programming details about architecture-specific
83implementation.
84
85.. toctree::
86   :maxdepth: 2
87
88   arch/index
89
90Board-specific doc
91------------------
92
93These books provide details about board-specific information. They are
94organized in a vendor subdirectory.
95
96.. toctree::
97   :maxdepth: 2
98
99   board/index
100
101Android-specific doc
102--------------------
103
104These books provide information about booting the Android OS from U-Boot,
105manipulating Android images from U-Boot shell and discusses other
106Android-specific features available in U-Boot.
107
108.. toctree::
109   :maxdepth: 2
110
111   android/index
112
113Indices and tables
114==================
115
116* :ref:`genindex`
117