Provide comments for efi_convert_device_node_to_text()
and efi_convert_device_path_to_text().

Signed-off-by: Heinrich Schuchardt <xypron.g...@gmx.de>
---
 lib/efi_loader/efi_device_path_to_text.c | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/lib/efi_loader/efi_device_path_to_text.c 
b/lib/efi_loader/efi_device_path_to_text.c
index 55007a527d..023fbaf69a 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,
@@ -236,6 +248,18 @@ static uint16_t EFIAPI *efi_convert_device_node_to_text(
        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,
-- 
2.14.2

_______________________________________________
U-Boot mailing list
U-Boot@lists.denx.de
https://lists.denx.de/listinfo/u-boot

Reply via email to