summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorHeinrich Schuchardt <xypron.glpk@gmx.de>2017-11-24 00:21:58 +0300
committerAlexander Graf <agraf@suse.de>2017-12-01 15:43:00 +0300
commitc4574208b0bc7aa7d50407250074b1651de3c84c (patch)
tree28a1379550dce89e478753f825c37b9be23d24ef /lib
parent44549d62c31dc433366b4c5d6e58e0e3091e542b (diff)
downloadu-boot-c4574208b0bc7aa7d50407250074b1651de3c84c.tar.xz
efi_loader: comments for EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
Provide comments for efi_convert_device_node_to_text() and efi_convert_device_path_to_text(). Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Signed-off-by: Alexander Graf <agraf@suse.de>
Diffstat (limited to 'lib')
-rw-r--r--lib/efi_loader/efi_device_path_to_text.c24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/efi_loader/efi_device_path_to_text.c b/lib/efi_loader/efi_device_path_to_text.c
index 43af5dfd8d..9e62e4a929 100644
--- a/lib/efi_loader/efi_device_path_to_text.c
+++ b/lib/efi_loader/efi_device_path_to_text.c
@@ -218,6 +218,18 @@ static char *efi_convert_single_device_node_to_text(
return str;
}
+/*
+ * This function implements the ConvertDeviceNodeToText service of the
+ * EFI_DEVICE_PATH_TO_TEXT_PROTOCOL.
+ * See the Unified Extensible Firmware Interface (UEFI) specification
+ * for details.
+ *
+ * device_node device node to be converted
+ * display_only true if the shorter text represenation shall be used
+ * allow_shortcuts true if shortcut forms may be used
+ * @return text represenation of the device path
+ * NULL if out of memory of device_path is NULL
+ */
static uint16_t EFIAPI *efi_convert_device_node_to_text(
struct efi_device_path *device_node,
bool display_only,
@@ -239,6 +251,18 @@ out:
return text;
}
+/*
+ * This function implements the ConvertDevicePathToText service of the
+ * EFI_DEVICE_PATH_TO_TEXT_PROTOCOL.
+ * See the Unified Extensible Firmware Interface (UEFI) specification
+ * for details.
+ *
+ * device_path device path to be converted
+ * display_only true if the shorter text represenation shall be used
+ * allow_shortcuts true if shortcut forms may be used
+ * @return text represenation of the device path
+ * NULL if out of memory of device_path is NULL
+ */
static uint16_t EFIAPI *efi_convert_device_path_to_text(
struct efi_device_path *device_path,
bool display_only,