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>
This commit is contained in:
Heinrich Schuchardt 2017-11-23 22:21:58 +01:00 committed by Alexander Graf
parent 44549d62c3
commit c4574208b0

View file

@ -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,