blob: cd98be6cc5fdaab0f20bb4eea301b25465965e23 [file] [log] [blame]
Heinrich Schuchardt04459782018-07-29 13:45:47 +02001.. SPDX-License-Identifier: GPL-2.0+
Mario Six78a88f72018-07-10 08:40:17 +02002
Bin Mengf0e608b2019-07-18 00:33:47 -07003.. _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
Mario Six78a88f72018-07-10 08:40:17 +020017
Bin Meng7114d892019-10-27 05:19:45 -070018User-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
Heinrich Schuchardt73d95c22019-07-26 06:46:08 +020029Unified Extensible Firmware (UEFI)
30----------------------------------
31
32U-Boot provides an implementation of the UEFI API allowing to run UEFI
33compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
34can be run an UEFI payload.
35
36.. toctree::
37 :maxdepth: 2
38
39 uefi/index
40
Bin Mengd9756c42019-07-18 00:33:48 -070041Driver-Model documentation
42--------------------------
Heinrich Schuchardt73d95c22019-07-26 06:46:08 +020043
Bin Mengd9756c42019-07-18 00:33:48 -070044The following holds information on the U-Boot device driver framework:
45driver-model, including the design details of itself and several driver
46subsystems.
47
48.. toctree::
49 :maxdepth: 2
50
51 driver-model/index
52
Bin Mengc8fe9162019-07-18 00:33:46 -070053U-Boot API documentation
54------------------------
Mario Six78a88f72018-07-10 08:40:17 +020055
Bin Mengc8fe9162019-07-18 00:33:46 -070056These books get into the details of how specific U-Boot subsystems work
57from the point of view of a U-Boot developer. Much of the information here
58is taken directly from the U-Boot source, with supplemental material added
59as needed (or at least as we managed to add it - probably *not* all that is
60needed).
61
62.. toctree::
63 :maxdepth: 2
64
65 api/index
Bin Mengf0e608b2019-07-18 00:33:47 -070066
Bin Mengd8381382019-07-18 00:34:02 -070067Architecture-specific doc
68-------------------------
69
70These books provide programming details about architecture-specific
71implementation.
72
73.. toctree::
74 :maxdepth: 2
75
76 arch/index
77
Bin Meng428c3f52019-07-18 00:34:04 -070078Board-specific doc
79------------------
80
81These books provide details about board-specific information. They are
82organized in a vendor subdirectory.
83
84.. toctree::
85 :maxdepth: 2
86
87 board/index
88
Sam Protsenko586a1bf2020-01-24 17:53:44 +020089Android-specific doc
90--------------------
91
92These books provide information about booting the Android OS from U-Boot,
93manipulating Android images from U-Boot shell and discusses other
94Android-specific features available in U-Boot.
95
96.. toctree::
97 :maxdepth: 2
98
99 android/index
100
Bin Mengf0e608b2019-07-18 00:33:47 -0700101Indices and tables
102==================
103
104* :ref:`genindex`