efi_loader: improve description of efi_file_from_path()

Provide a description of the function's logic.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
This commit is contained in:
Heinrich Schuchardt 2022-11-10 14:14:06 +01:00
parent 3d595ac5f5
commit 95d18c5ed0

View file

@ -1098,6 +1098,15 @@ static const struct efi_file_handle efi_file_handle_protocol = {
/**
* efi_file_from_path() - open file via device path
*
* The device path @fp consists of the device path of the handle with the
* simple file system protocol and one or more file path device path nodes.
* The concatenation of all file path names provides the total file path.
*
* The code starts at the first file path node and tries to open that file or
* directory. If there is a succeding file path node, the code opens it relative
* to this directory and continues iterating until reaching the last file path
* node.
*
* @fp: device path
* Return: EFI_FILE_PROTOCOL for the file or NULL
*/