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 29Unified 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 41Driver-Model documentation 42-------------------------- 43 44The 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 53U-Boot API documentation 54------------------------ 55 56These 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 66 67Architecture-specific doc 68------------------------- 69 70These books provide programming details about architecture-specific 71implementation. 72 73.. toctree:: 74 :maxdepth: 2 75 76 arch/index 77 78Board-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 89Indices and tables 90================== 91 92* :ref:`genindex` 93