diff options
| author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-10 10:30:43 +0000 |
|---|---|---|
| committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-10 10:30:43 +0000 |
| commit | 744fc758191ec6c03ea0d487d3a6a829e7ae7ae3 (patch) | |
| tree | ac5b28dc552437574230ffff45835aae682e880a /MdeModulePkg | |
| parent | 0581905abba9349d24f4dfd60d56d66757c8c2fc (diff) | |
| download | edk2-platforms-744fc758191ec6c03ea0d487d3a6a829e7ae7ae3.tar.xz | |
Clean up BootMaint module in BdsDxe.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5446 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg')
12 files changed, 284 insertions, 363 deletions
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c index 11ae2b115c..4d5a4580c6 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c @@ -24,32 +24,32 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. the entire string is translated.
- @param a Pointer to input Ascii string.
+ @param AStr Pointer to input Ascii string.
@param Size The number of characters to translate.
- @param u Pointer to output Unicode string buffer.
+ @param UStr Pointer to output Unicode string buffer.
@return None
**/
VOID
AsciiToUnicodeSize (
- IN UINT8 *a,
+ IN UINT8 *AStr,
IN UINTN Size,
- OUT UINT16 *u
+ OUT UINT16 *UStr
)
{
- UINTN i;
+ UINTN Idx;
- i = 0;
- while (a[i] != 0) {
- u[i] = (CHAR16) a[i];
- if (i == Size) {
+ Idx = 0;
+ while (AStr[Idx] != 0) {
+ UStr[Idx] = (CHAR16) AStr[Idx];
+ if (Idx == Size) {
break;
}
- i++;
+ Idx++;
}
- u[i] = 0;
+ UStr[Idx] = 0;
}
/**
@@ -85,14 +85,14 @@ UnicodeToAscii ( }
/**
- EDES_TODO: Add function description.
+ Build Legacy Device Name String according.
- @param CurBBSEntry EDES_TODO: Add parameter description
- @param Index EDES_TODO: Add parameter description
- @param BufSize EDES_TODO: Add parameter description
- @param BootString EDES_TODO: Add parameter description
+ @param CurBBSEntry BBS Table.
+ @param Index Index.
+ @param BufSize The buffer size.
+ @param BootString The output string.
- @return EDES_TODO: Add description for return value
+ @return VOID No output.
**/
VOID
@@ -106,7 +106,7 @@ BdsBuildLegacyDevNameString ( CHAR16 *Fmt;
CHAR16 *Type;
UINT8 *StringDesc;
- CHAR16 temp[80];
+ CHAR16 Temp[80];
switch (Index) {
//
@@ -184,9 +184,9 @@ BdsBuildLegacyDevNameString ( //
// Only get fisrt 32 characters, this is suggested by BBS spec
//
- AsciiToUnicodeSize (StringDesc, 32, temp);
+ AsciiToUnicodeSize (StringDesc, 32, Temp);
Fmt = L"%s";
- Type = temp;
+ Type = Temp;
}
//
@@ -386,13 +386,14 @@ BdsCreateLegacyBootOption ( }
/**
- EDES_TODO: Add function description.
+ Check if the boot option is a legacy one.
- @param BootOptionVar EDES_TODO: Add parameter description
- @param BbsEntry EDES_TODO: Add parameter description
- @param BbsIndex EDES_TODO: Add parameter description
+ @param BootOptionVar The boot option data payload.
+ @param BbsEntry The BBS Table.
+ @param BbsIndex The table index.
- @return EDES_TODO: Add description for return value
+ @retval TRUE It is a legacy boot option.
+ @retval FALSE It is not a legacy boot option.
**/
BOOLEAN
@@ -428,67 +429,15 @@ BdsIsLegacyBootOption ( }
/**
+ Delete all the invalid legacy boot options.
- Delete boot option specified by OptionNumber and adjust the boot order.
-
- @param OptionNumber The boot option to be deleted.
- @param BootOrder Boot order list to be adjusted by remove this boot option.
- @param BootOrderSize The size of Boot order list will be modified.
- @retval EFI_SUCCESS The boot option is deleted successfully.
-
-**/
-EFI_STATUS
-EFIAPI
-BdsDeleteBootOption (
- IN UINTN OptionNumber,
- IN OUT UINT16 *BootOrder,
- IN OUT UINTN *BootOrderSize
- )
-{
- UINT16 BootOption[100];
- UINTN Index;
- EFI_STATUS Status;
- UINTN Index2Del;
-
- Status = EFI_SUCCESS;
- Index2Del = 0;
-
- UnicodeSPrint (BootOption, sizeof (BootOption), L"Boot%04x", OptionNumber);
- Status = EfiLibDeleteVariable (BootOption, &gEfiGlobalVariableGuid);
- //
- // adjust boot order array
- //
- for (Index = 0; Index < *BootOrderSize / sizeof (UINT16); Index++) {
- if (BootOrder[Index] == OptionNumber) {
- Index2Del = Index;
- break;
- }
- }
-
- if (Index != *BootOrderSize / sizeof (UINT16)) {
- for (Index = 0; Index < *BootOrderSize / sizeof (UINT16) - 1; Index++) {
- if (Index >= Index2Del) {
- BootOrder[Index] = BootOrder[Index + 1];
- }
- }
-
- *BootOrderSize -= sizeof (UINT16);
- }
-
- return Status;
-
-}
-
-/**
- Delete all the invalid legacy boot options.
@retval EFI_SUCCESS All invalide legacy boot options are deleted.
@retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.
@retval EFI_NOT_FOUND Fail to retrive variable of boot order.
**/
EFI_STATUS
-EFIAPI
BdsDeleteAllInvalidLegacyBootOptions (
VOID
)
@@ -613,16 +562,17 @@ BdsDeleteAllInvalidLegacyBootOptions ( }
/**
- EDES_TODO: Add function description.
+ Find all legacy boot option by device type.
- @param BootOrder EDES_TODO: Add parameter description
- @param BootOptionNum EDES_TODO: Add parameter description
- @param DevType EDES_TODO: Add parameter description
- @param Attribute EDES_TODO: Add parameter description
- @param BbsIndex EDES_TODO: Add parameter description
- @param OptionNumber EDES_TODO: Add parameter description
+ @param BootOrder The boot order array.
+ @param BootOptionNum The number of boot option.
+ @param DevType Device type.
+ @param Attribute The boot option attribute.
+ @param BbsIndex The BBS table index.
+ @param OptionNumber The boot option index.
- @return EDES_TODO: Add description for return value
+ @retval TRUE The Legacy boot option is found.
+ @retval FALSE The legacy boot option is not found.
**/
BOOLEAN
@@ -683,14 +633,16 @@ BdsFindLegacyBootOptionByDevType ( }
/**
- EDES_TODO: Add function description.
+ Create a legacy boot option.
- @param BbsItem EDES_TODO: Add parameter description
- @param Index EDES_TODO: Add parameter description
- @param BootOrderList EDES_TODO: Add parameter description
- @param BootOrderListSize EDES_TODO: Add parameter description
+ @param BbsItem The BBS Table entry.
+ @param Index Index of the specified entry in BBS table.
+ @param BootOrderList The boot order list.
+ @param BootOrderListSize The size of boot order list.
- @return EDES_TODO: Add description for return value
+ @retval EFI_OUT_OF_RESOURCE No enough memory.
+ @retval EFI_SUCCESS The function complete successfully.
+ @return Other value if the legacy boot option is not created.
**/
EFI_STATUS
@@ -739,12 +691,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.
**/
EFI_STATUS
-EFIAPI
BdsAddNonExistingLegacyBootOptions (
VOID
)
@@ -845,14 +798,14 @@ BdsAddNonExistingLegacyBootOptions ( }
/**
- EDES_TODO: Add function description.
+ Fill the device order buffer.
- @param BbsTable EDES_TODO: Add parameter description
- @param BbsType EDES_TODO: Add parameter description
- @param BbsCount EDES_TODO: Add parameter description
- @param Buf EDES_TODO: Add parameter description
+ @param BbsTable The BBS table.
+ @param BbsType The BBS Type.
+ @param BbsCount The BBS Count.
+ @param Buf device order buffer.
- @return EDES_TODO: Add description for return value
+ @return The device order buffer.
**/
UINT16 *
@@ -860,7 +813,7 @@ BdsFillDevOrderBuf ( IN BBS_TABLE *BbsTable,
IN BBS_TYPE BbsType,
IN UINTN BbsCount,
- IN UINT16 *Buf
+ OUT UINT16 *Buf
)
{
UINTN Index;
@@ -882,12 +835,16 @@ BdsFillDevOrderBuf ( }
/**
- EDES_TODO: Add function description.
+ Create the device order buffer.
- @param BbsTable EDES_TODO: Add parameter description
- @param BbsCount EDES_TODO: Add parameter description
+ @param BbsTable The BBS table.
+ @param BbsCount The BBS Count.
- @return EDES_TODO: Add description for return value
+ @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.
**/
EFI_STATUS
@@ -1024,7 +981,6 @@ BdsCreateDevOrder ( **/
EFI_STATUS
-EFIAPI
BdsUpdateLegacyDevOrder (
VOID
)
@@ -1057,7 +1013,7 @@ BdsUpdateLegacyDevOrder ( UINT16 *NewBEVPtr;
UINT16 *NewDevPtr;
UINT16 Length;
- UINT16 tmp;
+ UINT16 Tmp;
UINTN FDIndex;
UINTN HDIndex;
UINTN CDIndex;
@@ -1352,9 +1308,9 @@ BdsUpdateLegacyDevOrder ( for (Index2 = Index + 1; Index2 < FDIndex; Index2++) {
if (0 == (NewFDPtr[Index2] & 0xFF00)) {
- tmp = NewFDPtr[Index];
+ Tmp = NewFDPtr[Index];
NewFDPtr[Index] = NewFDPtr[Index2];
- NewFDPtr[Index2] = tmp;
+ NewFDPtr[Index2] = Tmp;
break;
}
}
@@ -1372,9 +1328,9 @@ BdsUpdateLegacyDevOrder ( for (Index2 = Index + 1; Index2 < HDIndex; Index2++) {
if (0 == (NewHDPtr[Index2] & 0xFF00)) {
- tmp = NewHDPtr[Index];
+ Tmp = NewHDPtr[Index];
NewHDPtr[Index] = NewHDPtr[Index2];
- NewHDPtr[Index2] = tmp;
+ NewHDPtr[Index2] = Tmp;
break;
}
}
@@ -1392,9 +1348,9 @@ BdsUpdateLegacyDevOrder ( for (Index2 = Index + 1; Index2 < CDIndex; Index2++) {
if (0 == (NewCDPtr[Index2] & 0xFF00)) {
- tmp = NewCDPtr[Index];
+ Tmp = NewCDPtr[Index];
NewCDPtr[Index] = NewCDPtr[Index2];
- NewCDPtr[Index2] = tmp;
+ NewCDPtr[Index2] = Tmp;
break;
}
}
@@ -1412,9 +1368,9 @@ BdsUpdateLegacyDevOrder ( for (Index2 = Index + 1; Index2 < NETIndex; Index2++) {
if (0 == (NewNETPtr[Index2] & 0xFF00)) {
- tmp = NewNETPtr[Index];
+ Tmp = NewNETPtr[Index];
NewNETPtr[Index] = NewNETPtr[Index2];
- NewNETPtr[Index2] = tmp;
+ NewNETPtr[Index2] = Tmp;
break;
}
}
@@ -1432,9 +1388,9 @@ BdsUpdateLegacyDevOrder ( for (Index2 = Index + 1; Index2 < BEVIndex; Index2++) {
if (0 == (NewBEVPtr[Index2] & 0xFF00)) {
- tmp = NewBEVPtr[Index];
+ Tmp = NewBEVPtr[Index];
NewBEVPtr[Index] = NewBEVPtr[Index2];
- NewBEVPtr[Index2] = tmp;
+ NewBEVPtr[Index2] = Tmp;
break;
}
}
@@ -1456,13 +1412,14 @@ BdsUpdateLegacyDevOrder ( }
/**
- EDES_TODO: Add function description.
+ Set Boot Priority for specified device type.
- @param DeviceType EDES_TODO: Add parameter description
- @param LocalBbsTable EDES_TODO: Add parameter description
- @param Priority EDES_TODO: Add parameter description
+ @param DeviceType The device type.
+ @param LocalBbsTable The BBS table.
+ @param Priority The prority table.
- @return EDES_TODO: Add description for return value
+ @retval EFI_SUCCESS The function completes successfully.
+ @retval EFI_NOT_FOUND Failed to find device.
**/
EFI_STATUS
@@ -1526,11 +1483,9 @@ BdsSetBootPriority4SameTypeDev ( }
/**
- EDES_TODO: Add function description.
-
- @param LocalBbsTable EDES_TODO: Add parameter description
+ Print the BBS Table.
- @return EDES_TODO: Add description for return value
+ @param LocalBbsTable The BBS table.
**/
VOID
@@ -1583,7 +1538,6 @@ PrintBbsTable ( **/
EFI_STATUS
-EFIAPI
BdsRefreshBbsTableForBoot (
IN BDS_COMMON_OPTION *Entry
)
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h index bab7de6326..542c9d9c46 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h @@ -12,24 +12,22 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/
-#ifndef _EFI_BDS_BBS_SUPPORT_H
-#define _EFI_BDS_BBS_SUPPORT_H
+#ifndef _EFI_BDS_BBS_SUPPORT_H_
+#define _EFI_BDS_BBS_SUPPORT_H_
#include "BootMaint.h"
-//
-// Bugbug: Candidate for a PCD entries
-//
+
#define MAX_BBS_ENTRIES 0x100
/**
- EDES_TODO: Add function description.
+ Build Legacy Device Name String according.
- @param CurBBSEntry EDES_TODO: Add parameter description
- @param Index EDES_TODO: Add parameter description
- @param BufSize EDES_TODO: Add parameter description
- @param BootString EDES_TODO: Add parameter description
+ @param CurBBSEntry BBS Table.
+ @param Index Index.
+ @param BufSize The buffer size.
+ @param BootString The output string.
- @return EDES_TODO: Add description for return value
+ @return VOID No output.
**/
VOID
@@ -41,12 +39,13 @@ BdsBuildLegacyDevNameString ( );
/**
- EDES_TODO: Add function description.
-
- @param VOID EDES_TODO: Add parameter description
+ Delete all the invalid legacy boot options.
- @return EDES_TODO: Add description for return value
+
+ @retval EFI_SUCCESS All invalide legacy boot options are deleted.
+ @retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.
+ @retval EFI_NOT_FOUND Fail to retrive variable of boot order.
**/
EFI_STATUS
BdsDeleteAllInvalidLegacyBootOptions (
@@ -58,7 +57,7 @@ BdsDeleteAllInvalidLegacyBootOptions ( Add the legacy boot options from BBS table if they do not exist.
- @param VOID EDES_TODO: Add parameter description
+
@retval EFI_SUCCESS The boot options are added successfully or they are already in boot options.
@retval others An error occurred when creating legacy boot options.
@@ -71,11 +70,11 @@ BdsAddNonExistingLegacyBootOptions ( ;
/**
- EDES_TODO: Add function description.
- @param VOID EDES_TODO: Add parameter description
+ Add the legacy boot devices from BBS table into
+ the legacy device boot order.
- @return EDES_TODO: Add description for return value
+ @retval EFI_SUCCESS The boot devices are added successfully.
**/
EFI_STATUS
@@ -84,11 +83,12 @@ BdsUpdateLegacyDevOrder ( );
/**
- EDES_TODO: Add function description.
- @param Entry EDES_TODO: Add parameter description
+ Set the boot priority for BBS entries based on boot option entry and boot order.
- @return EDES_TODO: Add description for return value
+ @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.
**/
EFI_STATUS
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BmLib.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BmLib.c index 1630eeb155..c6b44d61d7 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BmLib.c +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BmLib.c @@ -17,7 +17,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /**
Find the first instance of this Protocol
- in the system and return it's interface
+ in the system and return it's interface.
@param ProtocolGuid Provides the protocol to search for
@@ -174,10 +174,10 @@ EfiLibGetVariable ( Function deletes the variable specified by VarName and VarGuid.
- @param VarName - A Null-terminated Unicode string that is
+ @param VarName A Null-terminated Unicode string that is
the name of the vendor's variable.
- @param VendorGuid - A unique identifier for the vendor.
+ @param VarGuid A unique identifier for the vendor.
@retval EFI_SUCCESS The variable was found and removed
@retval EFI_UNSUPPORTED The variable store was inaccessible
@@ -437,11 +437,13 @@ EfiLibStrFromDatahub ( UINT64 Count;
EFI_DATA_RECORD_HEADER *Record;
EFI_SUBCLASS_TYPE1_HEADER *DataHdr;
- EFI_GUID MiscGuid = EFI_MISC_SUBCLASS_GUID;
- EFI_MISC_ONBOARD_DEVICE_DATA *ob;
+ EFI_GUID MiscGuid;
+ EFI_MISC_ONBOARD_DEVICE_DATA *Ob;
EFI_MISC_PORT_INTERNAL_CONNECTOR_DESIGNATOR_DATA *Port;
EFI_TIME CurTime;
+ CopyGuid (&MiscGuid, &gEfiMiscSubClassGuid);
+
Status = gBS->LocateProtocol (
&gEfiDataHubProtocolGuid,
NULL,
@@ -470,9 +472,9 @@ EfiLibStrFromDatahub ( //
DataHdr = (EFI_SUBCLASS_TYPE1_HEADER *) (Record + 1);
if (EFI_MISC_ONBOARD_DEVICE_RECORD_NUMBER == DataHdr->RecordType) {
- ob = (EFI_MISC_ONBOARD_DEVICE_DATA *) (DataHdr + 1);
- if (BdsLibMatchDevicePaths ((EFI_DEVICE_PATH_PROTOCOL *) &ob->OnBoardDevicePath, DevPath)) {
- GetProducerString (&Record->ProducerName, ob->OnBoardDeviceDescription, &Desc);
+ Ob = (EFI_MISC_ONBOARD_DEVICE_DATA *) (DataHdr + 1);
+ if (BdsLibMatchDevicePaths ((EFI_DEVICE_PATH_PROTOCOL *) &Ob->OnBoardDevicePath, DevPath)) {
+ GetProducerString (&Record->ProducerName, Ob->OnBoardDeviceDescription, &Desc);
return Desc;
}
}
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c index 432be94c9f..44b30d841e 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c @@ -35,9 +35,7 @@ CHAR16 mFileExplorerStorageName[] = L"FeData"; /**
Init all memu.
- @param CallbackData The
-
- @return EDES_TODO: Add description for return value
+ @param CallbackData The BMM context data.
**/
VOID
@@ -46,11 +44,7 @@ InitAllMenu ( );
/**
- EDES_TODO: Add function description.
-
- @param VOID EDES_TODO: Add parameter description
-
- @return EDES_TODO: Add description for return value
+ Free up all Menu Option list.
**/
VOID
@@ -737,7 +731,7 @@ Error: @param Private The BMM context data.
@param CurrentFakeNVMap The current Fack NV Map.
- @return VOID
+
**/
VOID
@@ -787,10 +781,8 @@ DiscardChangeHandler ( }
/**
- Initialize the Boot Maintenance Utitliy
-
+ Initialize the Boot Maintenance Utitliy.
- @param VOID EDES_TODO: Add parameter description
@retval EFI_SUCCESS utility ended successfully
@retval others contain some errors
@@ -1044,7 +1036,7 @@ InitializeBM ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1071,9 +1063,9 @@ InitAllMenu ( /**
Free up all Menu Option list.
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -1094,9 +1086,9 @@ FreeAllMenu ( Intialize all the string depositories.
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -1119,8 +1111,8 @@ InitializeStringDepository ( Fetch a usable string node from the string depository and return the string token.
- @param CallbackData EDES_TODO: Add parameter description
- @param StringDepository - Pointer of the string depository.
+ @param CallbackData The BMM context data.
+ @param StringDepository The string repository.
@retval EFI_STRING_ID String token.
@@ -1168,9 +1160,9 @@ GetStringTokenFromDepository ( Reclaim string depositories by moving the current node pointer to list head..
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -1192,9 +1184,9 @@ ReclaimStringDepository ( Release resource for all the string depositories.
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -1232,7 +1224,7 @@ CleanUpStringDepository ( Start boot maintenance manager
- @param VOID
+
@retval EFI_SUCCESS If BMM is invoked successfully.
@return Other value if BMM return unsuccessfully.
@@ -1285,7 +1277,7 @@ BdsStartBootMaint ( @param CallbackData The BMM context data.
@retval EFI_SUCCESS If function complete successfully.
- @retturn Other value if the Setup Browser process BMM's pages and
+ @return Other value if the Setup Browser process BMM's pages and
return unsuccessfully.
**/
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h index da7badd306..d15bbe04c8 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h @@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/
-#ifndef _BOOT_MAINT_H
-#define _BOOT_MAINT_H
+#ifndef _BOOT_MAINT_H_
+#define _BOOT_MAINT_H_
#include "Bds.h"
#include "BBSsupport.h"
@@ -23,9 +23,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. //
// Constants which are variable names used to access variables
//
-#define VarLegacyDevOrder L"LegacyDevOrder"
+#define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"
-#define VarConOutMode L"ConOutMode"
+#define VAR_CON_OUT_MODE L"ConOutMode"
//
// Guid of a NV Variable which store the information about the
@@ -39,16 +39,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. //
// String Contant
//
-#define StrFloppy L"Floppy Drive #%02x"
-#define StrHardDisk L"HardDisk Drive #%02x"
-#define StrCDROM L"ATAPI CDROM Drive #%02x"
-#define StrNET L"NET Drive #%02x"
-#define StrBEV L"BEV Drive #%02x"
-#define StrFloppyHelp L"Select Floppy Drive #%02x"
-#define StrHardDiskHelp L"Select HardDisk Drive #%02x"
-#define StrCDROMHelp L"Select ATAPI CDROM Drive #%02x"
-#define StrNETHelp L"NET Drive #%02x"
-#define StrBEVHelp L"BEV Drive #%02x"
+#define STR_FLOPPY L"Floppy Drive #%02x"
+#define STR_HARDDISK L"HardDisk Drive #%02x"
+#define STR_CDROM L"ATAPI CDROM Drive #%02x"
+#define STR_NET L"NET Drive #%02x"
+#define STR_BEV L"BEV Drive #%02x"
+#define STR_FLOPPY_HELP L"Select Floppy Drive #%02x"
+#define STR_HARDDISK_HELP L"Select HardDisk Drive #%02x"
+#define STR_CDROM_HELP L"Select ATAPI CDROM Drive #%02x"
+#define STR_NET_HELP L"NET Drive #%02x"
+#define STR_BEV_HELP L"BEV Drive #%02x"
//
// Variable created with this flag will be "Efi:...."
@@ -61,22 +61,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define MAX_CHAR 480
#define MAX_CHAR_SIZE (MAX_CHAR * 2)
-//
-// Check to see if current build support option active feature of
-// some driver option
-//
-#ifndef LOAD_OPTION_ACTIVE
-#define LOAD_OPTION_ACTIVE 0x00000001
-#endif
-
-//
-// Check to see if current build support force reconnect feature of
-// some driver option
-//
-#ifndef LOAD_OPTION_FORCE_RECONNECT
-#define LOAD_OPTION_FORCE_RECONNECT 0x00000002
-#endif
-
extern EFI_GUID mBootMaintGuid;
extern EFI_GUID mFileExplorerGuid;
@@ -493,10 +477,11 @@ BOpt_FindFileSystem ( All files and sub-directories in current directory
will be stored in DirectoryMenu for future use.
- @param FileOption Pointer for Dir to explore.
+ @param CallbackData The BMM context data.
+ @param MenuEntry The Menu Entry.
- @retval TRUE Get files from current dir successfully.
- @retval FALSE Can't get files from current dir.
+ @retval EFI_SUCCESS Get files from current dir successfully.
+ @return Other value if can't get files from current dir.
**/
EFI_STATUS
@@ -513,7 +498,7 @@ BOpt_FindFiles ( All valid handles in the system except those consume SimpleFs, LoadFile
are stored in DriverMenu for future use.
- @param VOID
+
@retval EFI_SUCCESS The function complets successfully.
@return Other value if failed to build the DriverMenu.
@@ -530,7 +515,7 @@ BOpt_FindDrivers ( Build the BootOptionMenu according to BootOrder Variable.
This Routine will access the Boot#### to get EFI_LOAD_OPTION.
- @param None
+ @param CallbackData The BMM context data.
@return The number of the Var Boot####.
@@ -560,7 +545,7 @@ BOpt_GetDriverOptions ( /**
Build the LegacyFDMenu LegacyHDMenu LegacyCDMenu according to LegacyBios.GetBbsInfo().
- @param VOID
+
@retval EFI_SUCCESS The function complete successfully.
@retval EFI_OUT_OF_RESOURCES No enough memory to complete this function.
@@ -574,9 +559,9 @@ BOpt_GetLegacyOptions ( /**
Free out resouce allocated from Legacy Boot Options.
- @param VOID.
+ .
- @return VOID.
+ .
**/
VOID
@@ -585,11 +570,11 @@ BOpt_FreeLegacyOptions ( );
/**
- Free resources allocated in Allocate Rountine
+ Free resources allocated in Allocate Rountine.
@param FreeMenu Menu to be freed
- @return VOID
+
**/
VOID
@@ -652,7 +637,7 @@ BOpt_IsEfiApp ( Get the Option Number that has not been allocated for use.
- @param VOID
+
@return The available Option Number.
@@ -666,7 +651,7 @@ BOpt_GetBootOptionNumber ( Get the Option Number that is not in use.
- @param VOID
+
@return The unused Option Number.
@@ -726,12 +711,11 @@ BOpt_GetMenuEntry ( // Locate all serial io devices for console
//
/**
- Build a list containing all serial devices
-
+ Build a list containing all serial devices.
- @param VOID EDES_TODO: Add parameter description
- @return EDES_TODO: Add description for return value
+ @retval EFI_SUCCESS The function complete successfully.
+ @retval EFI_UNSUPPORTED No serial ports present.
**/
EFI_STATUS
@@ -746,7 +730,7 @@ LocateSerialIo ( Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
- @param VOID
+
@retval EFI_SUCCESS The function always complete successfully.
@@ -765,7 +749,7 @@ GetAllConsoles( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -780,7 +764,7 @@ GetConsoleOutMode ( Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
- @param VOID EDES_TODO: Add parameter description
+ EDES_TODO: Add parameter description
@retval EFI_SUCCESS The function always complete successfully.
**/
@@ -796,13 +780,14 @@ FreeAllConsoles ( @param DevicePath
- @return VOID
+
**/
VOID
ChangeVariableDevicePath (
- EFI_DEVICE_PATH_PROTOCOL *DevicePath
-);
+ IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath
+ )
+;
/**
Update the multi-instance device path of Terminal Device based on
@@ -818,9 +803,9 @@ ChangeVariableDevicePath ( **/
EFI_STATUS
ChangeTerminalDevicePath (
- EFI_DEVICE_PATH_PROTOCOL *DevicePath,
- BOOLEAN ChangeTerminal
-);
+ IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath,
+ IN BOOLEAN ChangeTerminal
+ );
//
// Variable operation by menu selection
//
@@ -849,7 +834,7 @@ Var_UpdateBootOption ( make sure BootOrder is in valid state.
- @param VOID EDES_TODO: Add parameter description
+ EDES_TODO: Add parameter description
@retval EFI_SUCCESS If all boot load option EFI Variables corresponding to
BM_LOAD_CONTEXT marked for deletion is deleted
@@ -868,7 +853,7 @@ Var_DelBootOption ( scratch by content from BootOptionMenu is needed.
- @param VOID
+
@retval EFI_SUCCESS The boot order is updated successfully.
@return EFI_STATUS other than EFI_SUCCESS if failed to
@@ -911,7 +896,7 @@ Var_UpdateDriverOption ( make sure DriverOrder is in valid state.
- @param VOID
+
@retval EFI_SUCCESS Load Option is successfully updated.
@return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI
@@ -931,7 +916,7 @@ Var_DelDriverOption ( needed.
- @param VOID
+
@retval EFI_SUCCESS The driver order is updated successfully.
@return EFI_STATUS other than EFI_SUCCESS if failed to
@@ -948,7 +933,7 @@ Var_ChangeDriverOrder ( console device.
- @param VOID
+
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can be saved. See gRT->SetVariable
@@ -964,7 +949,7 @@ Var_UpdateConsoleInpOption ( console device.
- @param VOID
+
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can be saved. See gRT->SetVariable
@@ -980,7 +965,7 @@ Var_UpdateConsoleOutOption ( console device.
- @param VOID
+
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can be saved. See gRT->SetVariable
@@ -996,9 +981,9 @@ Var_UpdateErrorOutOption ( based on the new BaudRate, Data Bits, parity and Stop Bits
set.
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -1096,9 +1081,9 @@ Var_UpdateConMode ( /**
Refresh the global UpdateData structure.
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -1114,7 +1099,7 @@ RefreshUpdateData ( opcode deletion.
@param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1129,7 +1114,7 @@ CleanUpPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1142,7 +1127,7 @@ UpdateBootDelPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1157,7 +1142,7 @@ UpdateDrvAddHandlePage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1171,7 +1156,7 @@ UpdateDrvDelPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1186,7 +1171,7 @@ UpdateDriverAddHandleDescPage ( @param UpdatePageId The form ID.
@param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1201,7 +1186,7 @@ UpdatePageBody ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1215,7 +1200,7 @@ UpdateBootNextPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1230,7 +1215,7 @@ UpdateTimeOutPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1244,7 +1229,7 @@ UpdateTerminalPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1258,7 +1243,7 @@ UpdateConModePage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1273,14 +1258,14 @@ UpdateConCOMPage ( @param UpdatePageId The form ID. It also spefies the legacy device type.
@param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
UpdateSetLegacyDeviceOrderPage (
IN UINT16 UpdatePageId,
IN BMM_CALLBACK_DATA *CallbackData
-);
+ );
/**
@@ -1366,7 +1351,7 @@ DevicePathToStr ( /**
Find the first instance of this Protocol
- in the system and return it's interface
+ in the system and return it's interface.
@param ProtocolGuid Provides the protocol to search for
@@ -1408,7 +1393,7 @@ EfiReallocatePool ( @param Name String part of EFI variable name
@param VendorGuid GUID part of EFI variable name
- @param VariableSize Returns the size of the EFI variable that was read
+ @param VarSize Returns the size of the EFI variable that was read
@return Dynamically allocated memory that contains a copy of the EFI variable.
@return Caller is responsible freeing the buffer.
@@ -1429,7 +1414,7 @@ BdsLibGetVariableAndSize ( @param VarName - A Null-terminated Unicode string that is
the name of the vendor's variable.
- @param VendorGuid - A unique identifier for the vendor.
+ @param VarGuid - A unique identifier for the vendor.
@retval EFI_SUCCESS The variable was found and removed
@retval EFI_UNSUPPORTED The variable store was inaccessible
@@ -1517,7 +1502,7 @@ EfiLibStrFromDatahub ( @param OptionIndex Returns the index number (#### in Boot####).
@param OptionSize Return the size of the Boot### variable.
- @return VOID
+
**/
VOID *
@@ -1525,16 +1510,13 @@ GetLegacyBootOptionVar ( IN UINTN DeviceType,
OUT UINTN *OptionIndex,
OUT UINTN *OptionSize
- );
+ );
/**
- Initialize the Boot Maintenance Utitliy
-
+ Initialize the Boot Maintenance Utitliy.
- @param VOID EDES_TODO: Add parameter description
-
- @retval EFI_SUCCESS utility ended successfully
- @retval others contain some errors
+ @retval EFI_SUCCESS utility ended successfully.
+ @retval others contain some errors.
**/
EFI_STATUS
@@ -1546,7 +1528,7 @@ InitializeBM ( Start boot maintenance manager
- @param VOID
+
@retval EFI_SUCCESS If BMM is invoked successfully.
@return Other value if BMM return unsuccessfully.
@@ -1561,9 +1543,9 @@ BdsStartBootMaint ( Intialize all the string depositories.
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -1591,9 +1573,9 @@ GetStringTokenFromDepository ( Reclaim string depositories by moving the current node pointer to list head..
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -1605,9 +1587,9 @@ ReclaimStringDepository ( Release resource for all the string depositories.
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -1641,7 +1623,7 @@ ApplyChangeHandler ( @param Private The BMM context data.
@param CurrentFakeNVMap The current Fack NV Map.
- @return VOID
+
**/
VOID
@@ -1656,7 +1638,7 @@ DiscardChangeHandler ( @param Private The BMM context data.
@param NewPageId The original page ID.
- @return VOID
+
**/
VOID
@@ -1672,7 +1654,7 @@ UpdatePageId ( of the file to be boot from.
@retval EFI_SUCCESS The function completed successfull.
- @retun Other value if the boot from the file fails.
+ @return Other value if the boot from the file fails.
**/
EFI_STATUS
@@ -1742,7 +1724,7 @@ FileExplorerCallback ( @param CallbackData The BMM context data.
@retval EFI_SUCCESS If function complete successfully.
- @retturn Other value if the Setup Browser process BMM's pages and
+ @return Other value if the Setup Browser process BMM's pages and
return unsuccessfully.
**/
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootOption.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootOption.c index 8baff7bb4c..0d39ae8f8e 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootOption.c +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootOption.c @@ -501,11 +501,11 @@ BOpt_FindFileSystem ( }
/**
- Free resources allocated in Allocate Rountine
+ Free resources allocated in Allocate Rountine.
@param FreeMenu Menu to be freed
- @return VOID
+
**/
VOID
@@ -531,10 +531,11 @@ BOpt_FreeMenu ( All files and sub-directories in current directory
will be stored in DirectoryMenu for future use.
- @param FileOption Pointer for Dir to explore.
+ @param CallbackData The BMM context data.
+ @param MenuEntry The Menu Entry.
- @retval TRUE Get files from current dir successfully.
- @retval FALSE Can't get files from current dir.
+ @retval EFI_SUCCESS Get files from current dir successfully.
+ @return Other value if can't get files from current dir.
**/
EFI_STATUS
@@ -684,7 +685,7 @@ BOpt_FindFiles ( /**
Build the LegacyFDMenu LegacyHDMenu LegacyCDMenu according to LegacyBios.GetBbsInfo().
- @param VOID
+
@retval EFI_SUCCESS The function complete successfully.
@retval EFI_OUT_OF_RESOURCES No enough memory to complete this function.
@@ -824,9 +825,9 @@ BOpt_GetLegacyOptions ( /**
Free out resouce allocated from Legacy Boot Options.
- @param VOID.
+
- @return VOID.
+ .
**/
VOID
@@ -846,7 +847,7 @@ BOpt_FreeLegacyOptions ( Build the BootOptionMenu according to BootOrder Variable.
This Routine will access the Boot#### to get EFI_LOAD_OPTION.
- @param None
+ @param CallbackData The BMM context data.
@return The number of the Var Boot####.
@@ -1242,7 +1243,7 @@ BOpt_IsEfiApp ( All valid handles in the system except those consume SimpleFs, LoadFile
are stored in DriverMenu for future use.
- @param VOID
+
@retval EFI_SUCCESS The function complets successfully.
@return Other value if failed to build the DriverMenu.
@@ -1333,7 +1334,7 @@ BOpt_FindDrivers ( Get the Option Number that has not been allocated for use.
- @param VOID
+
@return The available Option Number.
@@ -1409,7 +1410,7 @@ BOpt_GetBootOptionNumber ( Get the Option Number that is not in use.
- @param VOID
+
@return The unused Option Number.
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c index 0364ba64d3..39be20bdbc 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c @@ -58,8 +58,8 @@ UpdateComAttributeFromVariable ( **/
EFI_STATUS
ChangeTerminalDevicePath (
- EFI_DEVICE_PATH_PROTOCOL *DevicePath,
- IN BOOLEAN ChangeTerminal
+ IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath,
+ IN BOOLEAN ChangeTerminal
)
{
EFI_DEVICE_PATH_PROTOCOL *Node;
@@ -172,7 +172,7 @@ ChangeTerminalDevicePath ( @param DevicePath
- @return VOID
+
**/
VOID
@@ -287,7 +287,7 @@ RetrieveUartUid ( }
/**
- Sort Uart handles array with Acpi->UID from low to high
+ Sort Uart handles array with Acpi->UID from low to high.
@param Handles EFI_SERIAL_IO_PROTOCOL handle buffer
@@ -353,12 +353,11 @@ IsTerminalDevicePath ( );
/**
- Build a list containing all serial devices
+ Build a list containing all serial devices.
- @param VOID EDES_TODO: Add parameter description
-
- @return EDES_TODO: Add description for return value
+ @retval EFI_SUCCESS The function complete successfully.
+ @retval EFI_UNSUPPORTED No serial ports present.
**/
EFI_STATUS
@@ -859,7 +858,7 @@ GetConsoleMenu ( Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
- @param VOID
+
@retval EFI_SUCCESS The function always complete successfully.
@@ -879,7 +878,7 @@ GetAllConsoles ( Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
- @param VOID EDES_TODO: Add parameter description
+ EDES_TODO: Add parameter description
@retval EFI_SUCCESS The function always complete successfully.
**/
@@ -985,7 +984,7 @@ IsTerminalDevicePath ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1005,7 +1004,7 @@ GetConsoleOutMode ( ConOut = gST->ConOut;
MaxMode = (UINTN) (ConOut->Mode->MaxMode);
- ModeInfo = EfiLibGetVariable (VarConOutMode, &gEfiGenericPlatformVariableGuid);
+ ModeInfo = EfiLibGetVariable (VAR_CON_OUT_MODE, &gEfiGenericPlatformVariableGuid);
if (ModeInfo != NULL) {
CurrentCol = ModeInfo->Column;
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c index c2c6252076..fb49a6452d 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c @@ -21,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param CallbackData The BMM context data.
@param MenuOption Pointer to menu options to display.
- @return VOID
+
**/
VOID
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h b/MdeModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h index 5af27a6388..d0346d8095 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h @@ -11,8 +11,8 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
-#ifndef _FORM_GUID_H
-#define _FORM_GUID_H
+#ifndef _FORM_GUID_H_
+#define _FORM_GUID_H_
#define BOOT_MAINT_FORMSET_GUID \
{ \
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c index 1791a5cca2..5f8b1779df 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c @@ -17,9 +17,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /**
Refresh the global UpdateData structure.
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -37,7 +37,7 @@ RefreshUpdateData ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -70,7 +70,7 @@ UpdatePageStart ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -130,7 +130,7 @@ UpdatePageEnd ( opcode deletion.
@param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -161,7 +161,7 @@ CleanUpPage ( of the file to be boot from.
@retval EFI_SUCCESS The function completed successfull.
- @retun Other value if the boot from the file fails.
+ @return Other value if the boot from the file fails.
**/
EFI_STATUS
@@ -203,7 +203,7 @@ BootThisFile ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -241,7 +241,7 @@ UpdateConCOMPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -288,7 +288,7 @@ UpdateBootDelPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -326,7 +326,7 @@ UpdateDrvAddHandlePage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -372,7 +372,7 @@ UpdateDrvDelPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -438,13 +438,13 @@ UpdateDriverAddHandleDescPage ( }
/**
- EDES_TODO: Add function description.
+ Update console page.
- @param UpdatePageId EDES_TODO: Add parameter description
- @param ConsoleMenu EDES_TODO: Add parameter description
+ @param UpdatePageId The form ID to be updated.
+ @param ConsoleMenu The console menu list.
@param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -528,7 +528,7 @@ UpdateConsolePage ( @param OptionMenu The new list.
@param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -597,7 +597,7 @@ UpdateOrderPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -671,7 +671,7 @@ UpdateBootNextPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -713,7 +713,7 @@ UpdateTimeOutPage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -822,7 +822,7 @@ UpdateConModePage ( @param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -998,7 +998,7 @@ UpdateTerminalPage ( @param UpdatePageId The form ID.
@param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1043,7 +1043,7 @@ UpdatePageBody ( @param OptionIndex Returns the index number (#### in Boot####).
@param OptionSize Return the size of the Boot### variable.
- @return VOID
+
**/
VOID *
@@ -1125,7 +1125,7 @@ GetLegacyBootOptionVar ( @param UpdatePageId The form ID. It also spefies the legacy device type.
@param CallbackData The BMM context data.
- @return VOID
+
**/
VOID
@@ -1179,8 +1179,8 @@ UpdateSetLegacyDeviceOrderPage ( case FORM_SET_FD_ORDER_ID:
OptionMenu = (BM_MENU_OPTION *) &LegacyFDMenu;
Key = (UINT16) LEGACY_FD_QUESTION_ID;
- TypeStr = StrFloppy;
- TypeStrHelp = StrFloppyHelp;
+ TypeStr = STR_FLOPPY;
+ TypeStrHelp = STR_FLOPPY_HELP;
BbsType = BBS_FLOPPY;
LegacyOrder = CallbackData->BmmFakeNvData.LegacyFD;
OldData = CallbackData->BmmOldFakeNVData.LegacyFD;
@@ -1189,8 +1189,8 @@ UpdateSetLegacyDeviceOrderPage ( case FORM_SET_HD_ORDER_ID:
OptionMenu = (BM_MENU_OPTION *) &LegacyHDMenu;
Key = (UINT16) LEGACY_HD_QUESTION_ID;
- TypeStr = StrHardDisk;
- TypeStrHelp = StrHardDiskHelp;
+ TypeStr = STR_HARDDISK;
+ TypeStrHelp = STR_HARDDISK_HELP;
BbsType = BBS_HARDDISK;
LegacyOrder = CallbackData->BmmFakeNvData.LegacyHD;
OldData = CallbackData->BmmOldFakeNVData.LegacyHD;
@@ -1199,8 +1199,8 @@ UpdateSetLegacyDeviceOrderPage ( case FORM_SET_CD_ORDER_ID:
OptionMenu = (BM_MENU_OPTION *) &LegacyCDMenu;
Key = (UINT16) LEGACY_CD_QUESTION_ID;
- TypeStr = StrCDROM;
- TypeStrHelp = StrCDROMHelp;
+ TypeStr = STR_CDROM;
+ TypeStrHelp = STR_CDROM_HELP;
BbsType = BBS_CDROM;
LegacyOrder = CallbackData->BmmFakeNvData.LegacyCD;
OldData = CallbackData->BmmOldFakeNVData.LegacyCD;
@@ -1209,8 +1209,8 @@ UpdateSetLegacyDeviceOrderPage ( case FORM_SET_NET_ORDER_ID:
OptionMenu = (BM_MENU_OPTION *) &LegacyNETMenu;
Key = (UINT16) LEGACY_NET_QUESTION_ID;
- TypeStr = StrNET;
- TypeStrHelp = StrNETHelp;
+ TypeStr = STR_NET;
+ TypeStrHelp = STR_NET_HELP;
BbsType = BBS_EMBED_NETWORK;
LegacyOrder = CallbackData->BmmFakeNvData.LegacyNET;
OldData = CallbackData->BmmOldFakeNVData.LegacyNET;
@@ -1219,8 +1219,8 @@ UpdateSetLegacyDeviceOrderPage ( case FORM_SET_BEV_ORDER_ID:
OptionMenu = (BM_MENU_OPTION *) &LegacyBEVMenu;
Key = (UINT16) LEGACY_BEV_QUESTION_ID;
- TypeStr = StrBEV;
- TypeStrHelp = StrBEVHelp;
+ TypeStr = STR_BEV;
+ TypeStrHelp = STR_BEV_HELP;
BbsType = BBS_BEV_DEVICE;
LegacyOrder = CallbackData->BmmFakeNvData.LegacyBEV;
OldData = CallbackData->BmmOldFakeNVData.LegacyBEV;
@@ -1329,7 +1329,7 @@ UpdateSetLegacyDeviceOrderPage ( @param Private The BMM context data.
@param NewPageId The original page ID.
- @return VOID
+
**/
VOID
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c b/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c index 7837224e7e..35faf1ae27 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/Variable.c @@ -19,9 +19,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. After deleting this boot option, call Var_ChangeBootOrder to
make sure BootOrder is in valid state.
-
- @param VOID EDES_TODO: Add parameter description
-
@retval EFI_SUCCESS If all boot load option EFI Variables corresponding to
BM_LOAD_CONTEXT marked for deletion is deleted
@return Others If failed to update the "BootOrder" variable after deletion.
@@ -88,7 +85,7 @@ Var_DelBootOption ( scratch by content from BootOptionMenu is needed.
- @param VOID
+
@retval EFI_SUCCESS The boot order is updated successfully.
@return EFI_STATUS other than EFI_SUCCESS if failed to
@@ -180,7 +177,7 @@ Var_ChangeBootOrder ( make sure DriverOrder is in valid state.
- @param VOID
+
@retval EFI_SUCCESS Load Option is successfully updated.
@return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI
@@ -241,7 +238,7 @@ Var_DelDriverOption ( needed.
- @param VOID
+
@retval EFI_SUCCESS The driver order is updated successfully.
@return EFI_STATUS other than EFI_SUCCESS if failed to
@@ -323,9 +320,9 @@ Var_ChangeDriverOrder ( based on the new BaudRate, Data Bits, parity and Stop Bits
set.
- @param VOID
+
- @return VOID
+
**/
VOID
@@ -490,7 +487,7 @@ Var_UpdateConsoleOption ( console device.
- @param VOID
+
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can be saved. See gRT->SetVariable
@@ -509,7 +506,7 @@ Var_UpdateConsoleInpOption ( console device.
- @param VOID
+
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can be saved. See gRT->SetVariable
@@ -528,7 +525,7 @@ Var_UpdateConsoleOutOption ( console device.
- @param VOID
+
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can be saved. See gRT->SetVariable
@@ -552,7 +549,7 @@ Var_UpdateErrorOutOption ( @param HiiHandle The HII handle associated with the BMM formset.
@param DescriptionData The description of this driver option.
@param OptionalData The optional load option.
- @param ForceReconnect EDES_TODO: Add parameter description
+ @param ForceReconnect If to force reconnect.
@retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
@retval EFI_SUCCESS If function completes successfully.
@@ -736,7 +733,6 @@ Var_UpdateDriverOption ( @retval EFI_SUCCESS If function completes successfully.
**/
-
EFI_STATUS
Var_UpdateBootOption (
IN BMM_CALLBACK_DATA *CallbackData,
@@ -1429,7 +1425,7 @@ Var_UpdateConMode ( }
Status = gRT->SetVariable (
- VarConOutMode,
+ VAR_CON_OUT_MODE,
&gEfiGenericPlatformVariableGuid,
EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,
sizeof (CONSOLE_OUT_MODE),
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c index 9a1b3683e9..0abd781003 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c +++ b/MdeModulePkg/Universal/BdsDxe/BootMngr/BootManager.c @@ -154,12 +154,7 @@ InitializeBootManager ( }
/**
- Hook to enable UI timeout override behavior.
-
-
- @param VOID EDES_TODO: Add parameter description
-
- EDES_TODO: Incomplete Descriptions NONE
+ Invoke Boot Manager. Hook to enable UI timeout override behavior.
**/
VOID
|