sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add comments for the return value of GenericBdsLib functions.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8822 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4
2009-07-08 12:06:28 +00:00
parent 13b3137440
commit e83c9064f5
6 changed files with 107 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
View File

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

6
IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
View File

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

6
IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
View File

@@ -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[];