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.
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.
Developer-oriented documentation
The following manuals are written for developers of the U-Boot - those who want to contribute to U-Boot.
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).
- U-Boot API documentation
- Boot Count Limit
- Clock API
- Device firmware update
- Driver Model
- UEFI subsystem
- Events
- Option Parsing
- Interrupt API
- Linker-Generated Arrays
- Logical memory blocks
- Logging API
- NVMEM API
- Partition API
- Pinctrl and Pinmux
- Random number generation
- Sandbox
- Serial system
- System reset
- Timer Subsystem
- Unicode support
Architecture-specific doc
These books provide programming details about architecture-specific implementation.
Board-specific doc
These books provide details about board-specific information. They are organized in a vendor subdirectory.
- Board-specific doc
- Actions
- Advantech
- Andes Tech
- Allwinner (sunxi) boards
- Amlogic
- Anbernic
- Apple
- Arm Ltd
- ASUS
- Atmel
- Beacon
- BeagleBoard.org
- Broadcom
- BSH Hausgeraete GmbH
- Cloos
- Congatec
- Coreboot
- Emulation
- Gateworks
- Highbank
- HiSilicon
- HTC
- Intel
- Kontron
- Lenovo
- LG
- Mediatek
- Microchip
- Microsoft
- NXP Semiconductors
- OpenPiton
- PHYTEC
- Purism SPC
- Qualcomm
- Renesas
- Rockchip
- Samsung
- Schneider Electric
- Sielaff
- Siemens
- SiFive
- Sipeed
- Socionext
- Sophgo
- STMicroelectronics
- StarFive
- ST-Ericsson
- TBS
- T-HEAD
- Theobroma Systems
- Texas Instruments
- Toradex
- Variscite
- WEXLER
- XenGuestARM64
- Xilinx
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.