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