index.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  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. Unified Extensible Firmware (UEFI)
  14. ----------------------------------
  15. U-Boot provides an implementation of the UEFI API allowing to run UEFI
  16. compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
  17. can be run an UEFI payload.
  18. .. toctree::
  19. :maxdepth: 2
  20. uefi/index
  21. Driver-Model documentation
  22. --------------------------
  23. The following holds information on the U-Boot device driver framework:
  24. driver-model, including the design details of itself and several driver
  25. subsystems.
  26. .. toctree::
  27. :maxdepth: 2
  28. driver-model/index
  29. U-Boot API documentation
  30. ------------------------
  31. These books get into the details of how specific U-Boot subsystems work
  32. from the point of view of a U-Boot developer. Much of the information here
  33. is taken directly from the U-Boot source, with supplemental material added
  34. as needed (or at least as we managed to add it - probably *not* all that is
  35. needed).
  36. .. toctree::
  37. :maxdepth: 2
  38. api/index
  39. Architecture-specific doc
  40. -------------------------
  41. These books provide programming details about architecture-specific
  42. implementation.
  43. .. toctree::
  44. :maxdepth: 2
  45. arch/index
  46. Board-specific doc
  47. ------------------
  48. These books provide details about board-specific information. They are
  49. organized in a vendor subdirectory.
  50. .. toctree::
  51. :maxdepth: 2
  52. board/index
  53. Indices and tables
  54. ==================
  55. * :ref:`genindex`