index.rst 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. .. SPDX-License-Identifier: GPL-2.0+
  2. .. _u-boot_doc:
  3. The U-Boot Documentation
  4. ========================
  5. This is the top level of the U-Boot's documentation tree. U-Boot
  6. documentation, like the U-Boot itself, is very much a work in progress;
  7. that is especially true as we work to integrate our many scattered
  8. documents into a coherent whole. Please note that improvements to the
  9. documentation are welcome; join the U-Boot list at http://lists.denx.de
  10. if you want to help out.
  11. .. toctree::
  12. :maxdepth: 2
  13. User-oriented documentation
  14. ---------------------------
  15. The following manuals are written for *users* of the U-Boot - those who are
  16. trying to get it to work optimally on a given system.
  17. .. toctree::
  18. :maxdepth: 2
  19. build/index
  20. Unified Extensible Firmware (UEFI)
  21. ----------------------------------
  22. U-Boot provides an implementation of the UEFI API allowing to run UEFI
  23. compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
  24. can be run an UEFI payload.
  25. .. toctree::
  26. :maxdepth: 2
  27. uefi/index
  28. Driver-Model documentation
  29. --------------------------
  30. The following holds information on the U-Boot device driver framework:
  31. driver-model, including the design details of itself and several driver
  32. subsystems.
  33. .. toctree::
  34. :maxdepth: 2
  35. driver-model/index
  36. U-Boot API documentation
  37. ------------------------
  38. These books get into the details of how specific U-Boot subsystems work
  39. from the point of view of a U-Boot developer. Much of the information here
  40. is taken directly from the U-Boot source, with supplemental material added
  41. as needed (or at least as we managed to add it - probably *not* all that is
  42. needed).
  43. .. toctree::
  44. :maxdepth: 2
  45. api/index
  46. Architecture-specific doc
  47. -------------------------
  48. These books provide programming details about architecture-specific
  49. implementation.
  50. .. toctree::
  51. :maxdepth: 2
  52. arch/index
  53. Board-specific doc
  54. ------------------
  55. These books provide details about board-specific information. They are
  56. organized in a vendor subdirectory.
  57. .. toctree::
  58. :maxdepth: 2
  59. board/index
  60. Indices and tables
  61. ==================
  62. * :ref:`genindex`