From 71a7de4467030362ef2582c355c086eb5fc4143f Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sat, 22 Feb 2020 07:47:20 +0100 Subject: [PATCH] doc/efi: add load file 2 protocol to HTML documentation 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 --- doc/api/efi.rst | 9 +++++++++ doc/uefi/uefi.rst | 12 ++++++++++++ 2 files changed, 21 insertions(+) diff --git a/doc/api/efi.rst b/doc/api/efi.rst index bc59382608..631c0ceb1d 100644 --- a/doc/api/efi.rst +++ b/doc/api/efi.rst @@ -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 ~~~~~~~~~~~~~~~~~ diff --git a/doc/uefi/uefi.rst b/doc/uefi/uefi.rst index a8fd886d6b..cfe2d84a4c 100644 --- a/doc/uefi/uefi.rst +++ b/doc/uefi/uefi.rst @@ -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 -----