From 8b5c80e0296c7050348a6a89f2cef66190c6141d Mon Sep 17 00:00:00 2001 From: Ruiyu Ni Date: Fri, 20 Apr 2018 16:21:32 +0800 Subject: [PATCH] MdeModulePkg/UefiBootManagerLib: fix AddLoadOptionVariable docs/prototype Clean up the leading comment and the prototype of EfiBootManagerAddLoadOptionVariable(): - the function may modify Option on output, annotate the parameter with OUT and update the documentation; - "@retval EFI_STATUS" and "@retval Others" are not idiomatic documentation, use @return instead; - sync comment and prototype between lib instance and lib class header. Change-Id: I8a609d6502b6f8929b2f568acaa147065003b6f4 Cc: Eric Dong Cc: Ruiyu Ni Cc: Star Zeng Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Laszlo Ersek Reviewed-by: Ruiyu Ni --- .../Include/Library/UefiBootManagerLib.h | 26 +++++++++++++------ .../Library/UefiBootManagerLib/BmLoadOption.c | 12 ++++++--- 2 files changed, 26 insertions(+), 12 deletions(-) diff --git a/MdeModulePkg/Include/Library/UefiBootManagerLib.h b/MdeModulePkg/Include/Library/UefiBootManagerLib.h index 97ac1f233c..1d862a4b26 100644 --- a/MdeModulePkg/Include/Library/UefiBootManagerLib.h +++ b/MdeModulePkg/Include/Library/UefiBootManagerLib.h @@ -176,20 +176,30 @@ EfiBootManagerLoadOptionToVariable ( ); /** - This function will update the Boot####/Driver####/SysPrep#### and the - BootOrder/DriverOrder/SysPrepOrder to add a new load option. + This function will register the new Boot####, Driver#### or SysPrep#### option. + After the *#### is updated, the *Order will also be updated. - @param Option Pointer to load option to add. - @param Position Position of the new load option to put in the BootOrder/DriverOrder/SysPrepOrder. + @param Option Pointer to load option to add. If on input + Option->OptionNumber is LoadOptionNumberUnassigned, + then on output Option->OptionNumber is updated to + the number of the new Boot####, + Driver#### or SysPrep#### option. + @param Position Position of the new load option to put in the ****Order variable. + + @retval EFI_SUCCESS The *#### have been successfully registered. + @retval EFI_INVALID_PARAMETER The option number exceeds 0xFFFF. + @retval EFI_ALREADY_STARTED The option number of Option is being used already. + Note: this API only adds new load option, no replacement support. + @retval EFI_OUT_OF_RESOURCES There is no free option number that can be used when the + option number specified in the Option is LoadOptionNumberUnassigned. + @return Status codes of gRT->SetVariable (). - @retval EFI_SUCCESS The load option has been successfully added. - @retval Others Error status returned by RT->SetVariable. **/ EFI_STATUS EFIAPI EfiBootManagerAddLoadOptionVariable ( - IN EFI_BOOT_MANAGER_LOAD_OPTION *Option, - IN UINTN Position + IN OUT EFI_BOOT_MANAGER_LOAD_OPTION *Option, + IN UINTN Position ); /** diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c index 32918caf32..f88f8e0245 100644 --- a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c +++ b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c @@ -329,7 +329,11 @@ BmAddOptionNumberToOrderVariable ( This function will register the new Boot####, Driver#### or SysPrep#### option. After the *#### is updated, the *Order will also be updated. - @param Option Pointer to load option to add. + @param Option Pointer to load option to add. If on input + Option->OptionNumber is LoadOptionNumberUnassigned, + then on output Option->OptionNumber is updated to + the number of the new Boot####, + Driver#### or SysPrep#### option. @param Position Position of the new load option to put in the ****Order variable. @retval EFI_SUCCESS The *#### have been successfully registered. @@ -338,14 +342,14 @@ BmAddOptionNumberToOrderVariable ( Note: this API only adds new load option, no replacement support. @retval EFI_OUT_OF_RESOURCES There is no free option number that can be used when the option number specified in the Option is LoadOptionNumberUnassigned. - @retval EFI_STATUS Return the status of gRT->SetVariable (). + @return Status codes of gRT->SetVariable (). **/ EFI_STATUS EFIAPI EfiBootManagerAddLoadOptionVariable ( - IN EFI_BOOT_MANAGER_LOAD_OPTION *Option, - IN UINTN Position + IN OUT EFI_BOOT_MANAGER_LOAD_OPTION *Option, + IN UINTN Position ) { EFI_STATUS Status; -- 2.39.2