doc/efi: add load file 2 protocol to HTML documentation
authorHeinrich Schuchardt <xypron.glpk@gmx.de>
Sat, 22 Feb 2020 06:47:20 +0000 (07:47 +0100)
committerHeinrich Schuchardt <xypron.glpk@gmx.de>
Fri, 28 Feb 2020 18:37:14 +0000 (19:37 +0100)
The load file 2 protocol can be used by the Linux kernel to load the initial
RAM disk. U-Boot can be configured to provide an implementation.

Add a description to the UEFI overview and document the related functions
in the API section.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
doc/api/efi.rst
doc/uefi/uefi.rst

index bc593826082ad1f46488b241550b855713f941d8..631c0ceb1df1288824293499317dc8b668d29a28 100644 (file)
@@ -125,6 +125,15 @@ Graphical output protocol
 .. kernel-doc:: lib/efi_loader/efi_gop.c
    :internal:
 
+Load file 2 protocol
+~~~~~~~~~~~~~~~~~~~~
+
+The load file 2 protocol can be used by the Linux kernel to load the initial
+RAM disk. U-Boot can be configured to provide an implementation.
+
+.. kernel-doc:: lib/efi_loader/efi_load_initrd.c
+   :internal:
+
 Network protocols
 ~~~~~~~~~~~~~~~~~
 
index a8fd886d6b5ebd3d4516fc4033aee6e4f8db35d7..cfe2d84a4c643196fdc0433325ec332db46c6d19 100644 (file)
@@ -356,6 +356,18 @@ This driver is only available if U-Boot is configured with::
     CONFIG_BLK=y
     CONFIG_PARTITIONS=y
 
+Miscellaneous
+-------------
+
+Load file 2 protocol
+~~~~~~~~~~~~~~~~~~~~
+
+The load file 2 protocol can be used by the Linux kernel to load the initial
+RAM disk. U-Boot can be configured to provide an implementation with::
+
+    EFI_LOAD_FILE2_INITRD=y
+    EFI_INITRD_FILESPEC=interface dev:part path_to_initrd
+
 Links
 -----