From e83c9064f5f83809760c84174f936bacccac1c02 Mon Sep 17 00:00:00 2001 From: lgao4 Date: Wed, 8 Jul 2009 12:06:28 +0000 Subject: Add comments for the return value of GenericBdsLib functions. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8822 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Universal/BdsDxe/BootMaint/BBSsupport.c | 40 ++++++++++++---------- .../Universal/BdsDxe/BootMaint/BootMaint.c | 6 ++-- .../Universal/BdsDxe/BootMaint/BootMaint.h | 6 ---- 3 files changed, 25 insertions(+), 27 deletions(-) (limited to 'IntelFrameworkModulePkg/Universal') diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c index 044e1387e8..7063aed60e 100644 --- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c +++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c @@ -675,12 +675,13 @@ BdsCreateOneLegacyBootOption ( } /** - Add the legacy boot options from BBS table if they do not exist. - @retval EFI_SUCCESS The boot options are added successfully - or they are already in boot options. - + @retval EFI_SUCCESS The boot options are added successfully + or they are already in boot options. + @retval EFI_NOT_FOUND No legacy boot options is found. + @retval EFI_OUT_OF_RESOURCE No enough memory. + @return Other value LegacyBoot options are not added. **/ EFI_STATUS EFIAPI @@ -826,12 +827,12 @@ BdsFillDevOrderBuf ( @param BbsTable The BBS table. @param BbsCount The BBS Count. - @retval EFI_SUCCES The buffer is created and the EFI variable named - VAR_LEGACY_DEV_ORDER and EfiLegacyDevOrderGuid is - set correctly. - @return Other value if the set of EFI variable fails. Check gRT->SetVariable - for detailed information. - + @retval EFI_SUCCES The buffer is created and the EFI variable named + VAR_LEGACY_DEV_ORDER and EfiLegacyDevOrderGuid is + set correctly. + @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough. + @retval EFI_DEVICE_ERROR Fail to add the device order into EFI variable fail + because of hardware error. **/ EFI_STATUS BdsCreateDevOrder ( @@ -968,12 +969,14 @@ BdsCreateDevOrder ( } /** - Add the legacy boot devices from BBS table into the legacy device boot order. - @retval EFI_SUCCESS The boot devices are added successfully. - + @retval EFI_SUCCESS The boot devices are added successfully. + @retval EFI_NOT_FOUND The legacy boot devices are not found. + @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough. + @retval EFI_DEVICE_ERROR Fail to add the legacy device boot order into EFI variable + because of hardware error. **/ EFI_STATUS EFIAPI @@ -1414,8 +1417,9 @@ BdsUpdateLegacyDevOrder ( @param LocalBbsTable The BBS table. @param Priority The prority table. - @retval EFI_SUCCESS The function completes successfully. - @retval EFI_NOT_FOUND Failed to find device. + @retval EFI_SUCCESS The function completes successfully. + @retval EFI_NOT_FOUND Failed to find device. + @retval EFI_OUT_OF_RESOURCES Failed to get the efi variable of device order. **/ EFI_STATUS @@ -1526,13 +1530,13 @@ PrintBbsTable ( } /** - Set the boot priority for BBS entries based on boot option entry and boot order. @param Entry The boot option is to be checked for refresh BBS table. - @retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully. - @return status of BdsSetBootPriority4SameTypeDev() + @retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully. + @retval EFI_NOT_FOUND BBS entries can't be found. + @retval EFI_OUT_OF_RESOURCES Failed to get the legacy device boot order. **/ EFI_STATUS EFIAPI diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c index d5674e3b42..23e38b1cea 100644 --- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c +++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c @@ -1397,9 +1397,9 @@ FormSetDispatcher ( @param BootOrder The Boot Order array. @param BootOrderSize The size of the Boot Order Array. - @return Other value if the Boot Option specified by OptionNumber is not deleteed succesfully. - @retval EFI_SUCCESS If function return successfully. - + @retval EFI_SUCCESS The Boot Option Variable was found and removed + @retval EFI_UNSUPPORTED The Boot Option Variable store was inaccessible + @retval EFI_NOT_FOUND The Boot Option Variable was not found **/ EFI_STATUS EFIAPI diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h index 781c747a35..42449fb90d 100644 --- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h +++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h @@ -55,12 +55,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // #define VAR_FLAG EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE -// -// Define Maxmim characters that will be accepted -// -#define MAX_CHAR 480 -#define MAX_CHAR_SIZE (MAX_CHAR * 2) - extern EFI_GUID mBootMaintGuid; extern EFI_GUID mFileExplorerGuid; extern CHAR16 mFileExplorerStorageName[]; -- cgit v1.2.3