Clean up BootMaint module in BdsDxe.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / BootMaint / BootMaint.h

diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h b/MdeModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
index da7badd306a3c9ce1dd638aa18523331a577b7a2..d15bbe04c826b8c50619f9fc9c97ce479ab35e13 100644 (file)
--- 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.
 \r
 **/\r
 \r
-#ifndef _BOOT_MAINT_H\r
-#define _BOOT_MAINT_H\r
+#ifndef _BOOT_MAINT_H_\r
+#define _BOOT_MAINT_H_\r
 \r
 #include "Bds.h"\r
 #include "BBSsupport.h"\r
@@ -23,9 +23,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 // Constants which are variable names used to access variables\r
 //\r
-#define VarLegacyDevOrder L"LegacyDevOrder"\r
+#define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"\r
 \r
-#define VarConOutMode L"ConOutMode"\r
+#define VAR_CON_OUT_MODE L"ConOutMode"\r
 \r
 //\r
 // Guid of a NV Variable which store the information about the\r
@@ -39,16 +39,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 // String Contant\r
 //\r
-#define StrFloppy       L"Floppy Drive #%02x"\r
-#define StrHardDisk     L"HardDisk Drive #%02x"\r
-#define StrCDROM        L"ATAPI CDROM Drive #%02x"\r
-#define StrNET          L"NET Drive #%02x"\r
-#define StrBEV          L"BEV Drive #%02x"\r
-#define StrFloppyHelp   L"Select Floppy Drive #%02x"\r
-#define StrHardDiskHelp L"Select HardDisk Drive #%02x"\r
-#define StrCDROMHelp    L"Select ATAPI CDROM Drive #%02x"\r
-#define StrNETHelp      L"NET Drive #%02x"\r
-#define StrBEVHelp      L"BEV Drive #%02x"\r
+#define STR_FLOPPY       L"Floppy Drive #%02x"\r
+#define STR_HARDDISK     L"HardDisk Drive #%02x"\r
+#define STR_CDROM        L"ATAPI CDROM Drive #%02x"\r
+#define STR_NET          L"NET Drive #%02x"\r
+#define STR_BEV          L"BEV Drive #%02x"\r
+#define STR_FLOPPY_HELP   L"Select Floppy Drive #%02x"\r
+#define STR_HARDDISK_HELP L"Select HardDisk Drive #%02x"\r
+#define STR_CDROM_HELP    L"Select ATAPI CDROM Drive #%02x"\r
+#define STR_NET_HELP      L"NET Drive #%02x"\r
+#define STR_BEV_HELP      L"BEV Drive #%02x"\r
 \r
 //\r
 // Variable created with this flag will be "Efi:...."\r
@@ -61,22 +61,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define MAX_CHAR      480\r
 #define MAX_CHAR_SIZE (MAX_CHAR * 2)\r
 \r
-//\r
-// Check to see if current build support option active feature of\r
-// some driver option\r
-//\r
-#ifndef LOAD_OPTION_ACTIVE\r
-#define LOAD_OPTION_ACTIVE  0x00000001\r
-#endif\r
-\r
-//\r
-// Check to see if current build support force reconnect feature of\r
-// some driver option\r
-//\r
-#ifndef LOAD_OPTION_FORCE_RECONNECT\r
-#define LOAD_OPTION_FORCE_RECONNECT 0x00000002\r
-#endif\r
-\r
 extern EFI_GUID mBootMaintGuid;\r
 extern EFI_GUID mFileExplorerGuid;\r
 \r
@@ -493,10 +477,11 @@ BOpt_FindFileSystem (
   All files and sub-directories in current directory\r
   will be stored in DirectoryMenu for future use.\r
 \r
-  @param FileOption  Pointer for Dir to explore.\r
+  @param CallbackData  The BMM context data.\r
+  @param MenuEntry     The Menu Entry.\r
 \r
-  @retval TRUE         Get files from current dir successfully.\r
-  @retval FALSE        Can't get files from current dir.\r
+  @retval EFI_SUCCESS         Get files from current dir successfully.\r
+  @return Other value if can't get files from current dir.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -513,7 +498,7 @@ BOpt_FindFiles (
   All valid handles in the system except those consume SimpleFs, LoadFile\r
   are stored in DriverMenu for future use.\r
 \r
-  @param VOID \r
+   \r
 \r
   @retval EFI_SUCCESS The function complets successfully.\r
   @return Other value if failed to build the DriverMenu.\r
@@ -530,7 +515,7 @@ BOpt_FindDrivers (
   Build the BootOptionMenu according to BootOrder Variable.\r
   This Routine will access the Boot#### to get EFI_LOAD_OPTION.\r
 \r
-  @param None\r
+  @param CallbackData The BMM context data.\r
 \r
   @return The number of the Var Boot####.\r
 \r
@@ -560,7 +545,7 @@ BOpt_GetDriverOptions (
 /**\r
   Build the LegacyFDMenu LegacyHDMenu LegacyCDMenu according to LegacyBios.GetBbsInfo().\r
 \r
-  @param VOID\r
+  \r
 \r
   @retval EFI_SUCCESS The function complete successfully.\r
   @retval EFI_OUT_OF_RESOURCES No enough memory to complete this function.\r
@@ -574,9 +559,9 @@ BOpt_GetLegacyOptions (
 /**\r
   Free out resouce allocated from Legacy Boot Options.\r
 \r
-  @param VOID.\r
+  .\r
 \r
-  @return VOID.\r
+  .\r
 \r
 **/\r
 VOID\r
@@ -585,11 +570,11 @@ BOpt_FreeLegacyOptions (
   );\r
 \r
 /**\r
-  Free resources allocated in Allocate Rountine\r
+  Free resources allocated in Allocate Rountine.\r
 \r
   @param FreeMenu        Menu to be freed\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -652,7 +637,7 @@ BOpt_IsEfiApp (
 \r
   Get the Option Number that has not been allocated for use.\r
 \r
-  @param VOID\r
+  \r
 \r
   @return The available Option Number.\r
 \r
@@ -666,7 +651,7 @@ BOpt_GetBootOptionNumber (
 \r
   Get the Option Number that is not in use.\r
 \r
-  @param VOID\r
+  \r
 \r
   @return The unused Option Number.\r
 \r
@@ -726,12 +711,11 @@ BOpt_GetMenuEntry (
 // Locate all serial io devices for console\r
 //\r
 /**\r
-  Build a list containing all serial devices\r
-\r
+  Build a list containing all serial devices.\r
 \r
-  @param VOID            EDES_TODO: Add parameter description\r
 \r
-  @return EDES_TODO: Add description for return value\r
+  @retval EFI_SUCCESS The function complete successfully.\r
+  @retval EFI_UNSUPPORTED No serial ports present.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -746,7 +730,7 @@ LocateSerialIo (
   Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
   @retval EFI_SUCCESS    The function always complete successfully.\r
 \r
@@ -765,7 +749,7 @@ GetAllConsoles(
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -780,7 +764,7 @@ GetConsoleOutMode (
   Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu\r
 \r
 \r
-  @param VOID            EDES_TODO: Add parameter description\r
+              EDES_TODO: Add parameter description\r
 \r
   @retval EFI_SUCCESS    The function always complete successfully.\r
 **/\r
@@ -796,13 +780,14 @@ FreeAllConsoles (
 \r
   @param DevicePath\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
 ChangeVariableDevicePath (\r
-  EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
-);\r
+  IN OUT EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
+  )\r
+;\r
 \r
 /**\r
   Update the multi-instance device path of Terminal Device based on\r
@@ -818,9 +803,9 @@ ChangeVariableDevicePath (
 **/\r
 EFI_STATUS\r
 ChangeTerminalDevicePath (\r
-  EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
-  BOOLEAN                   ChangeTerminal\r
-);\r
+  IN OUT EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
+  IN BOOLEAN                   ChangeTerminal\r
+  );\r
 //\r
 // Variable operation by menu selection\r
 //\r
@@ -849,7 +834,7 @@ Var_UpdateBootOption (
   make sure BootOrder is in valid state.\r
 \r
 \r
-  @param VOID            EDES_TODO: Add parameter description\r
+              EDES_TODO: Add parameter description\r
 \r
   @retval EFI_SUCCESS   If all boot load option EFI Variables corresponding to  \r
                         BM_LOAD_CONTEXT marked for deletion is deleted\r
@@ -868,7 +853,7 @@ Var_DelBootOption (
   scratch by content from BootOptionMenu is needed.\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
   @retval  EFI_SUCCESS  The boot order is updated successfully.\r
   @return               EFI_STATUS other than EFI_SUCCESS if failed to\r
@@ -911,7 +896,7 @@ Var_UpdateDriverOption (
   make sure DriverOrder is in valid state.\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
   @retval EFI_SUCCESS Load Option is successfully updated.\r
   @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI\r
@@ -931,7 +916,7 @@ Var_DelDriverOption (
   needed.\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
   @retval  EFI_SUCCESS  The driver order is updated successfully.\r
   @return               EFI_STATUS other than EFI_SUCCESS if failed to\r
@@ -948,7 +933,7 @@ Var_ChangeDriverOrder (
   console device.\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
   @retval EFI_SUCCESS    The function complete successfully.\r
   @return                The EFI variable can be saved. See gRT->SetVariable \r
@@ -964,7 +949,7 @@ Var_UpdateConsoleInpOption (
   console device.\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
   @retval EFI_SUCCESS    The function complete successfully.\r
   @return                The EFI variable can be saved. See gRT->SetVariable \r
@@ -980,7 +965,7 @@ Var_UpdateConsoleOutOption (
   console device.\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
   @retval EFI_SUCCESS    The function complete successfully.\r
   @return                The EFI variable can be saved. See gRT->SetVariable \r
@@ -996,9 +981,9 @@ Var_UpdateErrorOutOption (
   based on the new BaudRate, Data Bits, parity and Stop Bits\r
   set.\r
 \r
-  @param VOID\r
+  \r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1096,9 +1081,9 @@ Var_UpdateConMode (
 /**\r
   Refresh the global UpdateData structure.\r
 \r
-  @param VOID\r
+  \r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1114,7 +1099,7 @@ RefreshUpdateData (
                          opcode deletion.\r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1129,7 +1114,7 @@ CleanUpPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1142,7 +1127,7 @@ UpdateBootDelPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1157,7 +1142,7 @@ UpdateDrvAddHandlePage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1171,7 +1156,7 @@ UpdateDrvDelPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1186,7 +1171,7 @@ UpdateDriverAddHandleDescPage (
   @param UpdatePageId    The form ID.\r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1201,7 +1186,7 @@ UpdatePageBody (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1215,7 +1200,7 @@ UpdateBootNextPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1230,7 +1215,7 @@ UpdateTimeOutPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1244,7 +1229,7 @@ UpdateTerminalPage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1258,7 +1243,7 @@ UpdateConModePage (
 \r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1273,14 +1258,14 @@ UpdateConCOMPage (
   @param UpdatePageId    The form ID. It also spefies the legacy device type.\r
   @param CallbackData    The BMM context data.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
 UpdateSetLegacyDeviceOrderPage (\r
   IN UINT16                           UpdatePageId,\r
   IN BMM_CALLBACK_DATA                *CallbackData\r
-);\r
+  );\r
 \r
 \r
 /**\r
@@ -1366,7 +1351,7 @@ DevicePathToStr (
 /**\r
 \r
   Find the first instance of this Protocol\r
-  in the system and return it's interface\r
+  in the system and return it's interface.\r
 \r
 \r
   @param ProtocolGuid    Provides the protocol to search for\r
@@ -1408,7 +1393,7 @@ EfiReallocatePool (
 \r
   @param  Name                  String part of EFI variable name\r
   @param  VendorGuid            GUID part of EFI variable name\r
-  @param  VariableSize          Returns the size of the EFI variable that was read\r
+  @param  VarSize          Returns the size of the EFI variable that was read\r
 \r
   @return Dynamically allocated memory that contains a copy of the EFI variable.\r
   @return Caller is responsible freeing the buffer.\r
@@ -1429,7 +1414,7 @@ BdsLibGetVariableAndSize (
   @param VarName         - A Null-terminated Unicode string that is\r
                          the name of the vendor's variable.\r
                          \r
-  @param VendorGuid           - A unique identifier for the vendor.\r
+  @param VarGuid           - A unique identifier for the vendor.\r
 \r
   @retval  EFI_SUCCESS           The variable was found and removed\r
   @retval  EFI_UNSUPPORTED       The variable store was inaccessible\r
@@ -1517,7 +1502,7 @@ EfiLibStrFromDatahub (
   @param OptionIndex     Returns the index number (#### in Boot####).\r
   @param OptionSize      Return the size of the Boot### variable.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID                              *\r
@@ -1525,16 +1510,13 @@ GetLegacyBootOptionVar (
   IN  UINTN                            DeviceType,\r
   OUT UINTN                            *OptionIndex,\r
   OUT UINTN                            *OptionSize\r
- );\r
+  );\r
 \r
 /**\r
-  Initialize the Boot Maintenance Utitliy\r
-\r
+  Initialize the Boot Maintenance Utitliy.\r
 \r
-  @param VOID            EDES_TODO: Add parameter description\r
-\r
-  @retval  EFI_SUCCESS      utility ended successfully\r
-  @retval  others           contain some errors\r
+  @retval  EFI_SUCCESS      utility ended successfully.\r
+  @retval  others           contain some errors.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1546,7 +1528,7 @@ InitializeBM (
   Start boot maintenance manager\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
   @retval EFI_SUCCESS If BMM is invoked successfully.\r
   @return Other value if BMM return unsuccessfully.\r
@@ -1561,9 +1543,9 @@ BdsStartBootMaint (
   Intialize all the string depositories.\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1591,9 +1573,9 @@ GetStringTokenFromDepository (
   Reclaim string depositories by moving the current node pointer to list head..\r
 \r
 \r
-  @param VOID \r
+   \r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1605,9 +1587,9 @@ ReclaimStringDepository (
   Release resource for all the string depositories.\r
 \r
 \r
-  @param VOID\r
+  \r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1641,7 +1623,7 @@ ApplyChangeHandler (
   @param Private         The BMM context data.\r
   @param CurrentFakeNVMap The current Fack NV Map.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1656,7 +1638,7 @@ DiscardChangeHandler (
   @param Private         The BMM context data.\r
   @param NewPageId       The original page ID.\r
 \r
-  @return VOID\r
+  \r
 \r
 **/\r
 VOID\r
@@ -1672,7 +1654,7 @@ UpdatePageId (
                          of the file to be boot from.\r
 \r
   @retval EFI_SUCCESS    The function completed successfull.\r
-  @retun                 Other value if the boot from the file fails.\r
+  @return                 Other value if the boot from the file fails.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1742,7 +1724,7 @@ FileExplorerCallback (
   @param CallbackData    The BMM context data.\r
 \r
   @retval EFI_SUCCESS If function complete successfully.\r
-  @retturn Other value if the Setup Browser process BMM's pages and\r
+  @return Other value if the Setup Browser process BMM's pages and\r
            return unsuccessfully.\r
 \r
 **/\r