1) Make naming of enumeration type follows coding style

2) Add missing parameter in function description.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8606 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
index 765c77bf55f4051076a9b1df67ea3b0625479997..044e1387e8e5a41defa04d44c9c7ddfa660faf56 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c
@@ -3,7 +3,7 @@
   and manage the legacy boot option, all legacy boot option is getting from\r
   the legacy BBS table.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -1482,7 +1482,7 @@ BdsSetBootPriority4SameTypeDev (
   Print the BBS Table.\r
 \r
   @param LocalBbsTable   The BBS table.\r
-\r
+  @param BbsCount        The count of entry in BBS table.\r
 **/\r
 VOID\r
 PrintBbsTable (\r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
index da5611d2de9deb80c8b3e0b69536321d67566709..c0fd073aaa2e48989ebaae7f9b9b0904dace8815 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c
@@ -1,7 +1,7 @@
 /** @file\r
   The functions for Boot Maintainence Main menu.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -450,7 +450,7 @@ BootMaintCallback (
     if (QuestionId < CONFIG_OPTION_OFFSET) {\r
       switch (QuestionId) {\r
       case KEY_VALUE_BOOT_FROM_FILE:\r
-        Private->FeCurrentState = BOOT_FROM_FILE_STATE;\r
+        Private->FeCurrentState = FileExplorerStateBootFromFile;\r
 \r
         //\r
         // Exit Bmm main formset to send File Explorer formset.\r
@@ -459,7 +459,7 @@ BootMaintCallback (
         break;\r
 \r
       case FORM_BOOT_ADD_ID:\r
-        Private->FeCurrentState = ADD_BOOT_OPTION_STATE;\r
+        Private->FeCurrentState = FileExplorerStateAddBootOption;\r
 \r
         //\r
         // Exit Bmm main formset to send File Explorer formset.\r
@@ -468,7 +468,7 @@ BootMaintCallback (
         break;\r
 \r
       case FORM_DRV_ADD_FILE_ID:\r
-        Private->FeCurrentState = ADD_DRIVER_OPTION_STATE;\r
+        Private->FeCurrentState = FileExplorerStateAddDriverOptionState;\r
 \r
         //\r
         // Exit Bmm main formset to send File Explorer formset.\r
@@ -890,8 +890,8 @@ InitializeBM (
   BmmCallbackInfo->FeConfigAccess.ExtractConfig  = FakeExtractConfig;\r
   BmmCallbackInfo->FeConfigAccess.RouteConfig    = FakeRouteConfig;\r
   BmmCallbackInfo->FeConfigAccess.Callback       = FileExplorerCallback;\r
-  BmmCallbackInfo->FeCurrentState                = INACTIVE_STATE;\r
-  BmmCallbackInfo->FeDisplayContext              = UNKNOWN_CONTEXT;\r
+  BmmCallbackInfo->FeCurrentState                = FileExplorerStateInActive;\r
+  BmmCallbackInfo->FeDisplayContext              = FileExplorerDisplayUnknown;\r
 \r
   //\r
   // Install Device Path Protocol and Config Access protocol to driver handle\r
@@ -1355,7 +1355,7 @@ FormSetDispatcher (
     //\r
     // When this Formset returns, check if we are going to explore files.\r
     //\r
-    if (INACTIVE_STATE != CallbackData->FeCurrentState) {\r
+    if (FileExplorerStateInActive != CallbackData->FeCurrentState) {\r
       UpdateFileExplorer (CallbackData, 0);\r
 \r
       ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r
@@ -1372,8 +1372,8 @@ FormSetDispatcher (
         EnableResetRequired ();\r
       }\r
 \r
-      CallbackData->FeCurrentState    = INACTIVE_STATE;\r
-      CallbackData->FeDisplayContext  = UNKNOWN_CONTEXT;\r
+      CallbackData->FeCurrentState    = FileExplorerStateInActive;\r
+      CallbackData->FeDisplayContext  = FileExplorerDisplayUnknown;\r
       ReclaimStringDepository ();\r
     } else {\r
       break;\r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
index 1a6f076ecc0c80d9ad9a6bacbebdfb6f27726df6..781c747a3517699c512c7f1d1f3da5bc7aaa8b5d 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.h
@@ -1,7 +1,7 @@
 /** @file\r
   Header file for boot maintenance module.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -93,53 +93,25 @@ extern UINT8    FEBin[];
 //\r
 typedef UINT8 BBS_TYPE;\r
 \r
-typedef enum {\r
-  PC_ANSI                             = 0,\r
-  VT_100,\r
-  VT_100_PLUS,\r
-  VT_UTF8\r
+typedef enum _TYPE_OF_TERMINAL {\r
+  TerminalTypePcAnsi                             = 0,\r
+  TerminalTypeVt100,\r
+  TerminalTypeVt100Plus,\r
+  TerminalTypeVtUtf8\r
 } TYPE_OF_TERMINAL;\r
 \r
-typedef enum {\r
-  COM1                                = 0,\r
-  COM2,\r
-  UNKNOW_COM\r
-} TYPE_OF_COM;\r
-\r
-typedef enum {\r
-  CONIN                               = 0,\r
-  CONOUT,\r
-  CONERR,\r
-  UNKNOWN_CON\r
-} TYPE_OF_CON;\r
-\r
-typedef enum {\r
-  BAUDRATE                            = 0,\r
-  DATABITS,\r
-  PARITY,\r
-  STOPBITS,\r
-  UNKNOW_ATTR\r
-} TYPE_OF_ATTRIBUTE;\r
-\r
-typedef enum {\r
-  MANNER_GOTO                         = 0,\r
-  MANNER_CHECK,\r
-  MANNER_ONEOF,\r
-  MANNER_USER_DEFINE\r
-} TYPE_OF_UPATE_MANNER;\r
-\r
-typedef enum {\r
-  INACTIVE_STATE                      = 0,\r
-  BOOT_FROM_FILE_STATE,\r
-  ADD_BOOT_OPTION_STATE,\r
-  ADD_DRIVER_OPTION_STATE,\r
-  UNKNOWN_STATE\r
+typedef enum _FILE_EXPLORER_STATE {\r
+  FileExplorerStateInActive                      = 0,\r
+  FileExplorerStateBootFromFile,\r
+  FileExplorerStateAddBootOption,\r
+  FileExplorerStateAddDriverOptionState,\r
+  FileExplorerStateUnknown\r
 } FILE_EXPLORER_STATE;\r
 \r
-typedef enum {\r
-  FILE_SYSTEM,\r
-  DIRECTORY,\r
-  UNKNOWN_CONTEXT\r
+typedef enum _FILE_EXPLORER_DISPLAY_CONTEXT {\r
+  FileExplorerDisplayFileSystem,\r
+  FileExplorerDisplayDirectory,\r
+  FileExplorerDisplayUnknown\r
 } FILE_EXPLORER_DISPLAY_CONTEXT;\r
 \r
 //\r
@@ -436,10 +408,12 @@ typedef struct {
   FILE_EXPLORER_NV_DATA          FeFakeNvData;\r
 } BMM_CALLBACK_DATA;\r
 \r
-typedef struct _STRING_LIST_NODE {\r
+typedef struct _STRING_LIST_NODE STRING_LIST_NODE;\r
+\r
+struct _STRING_LIST_NODE {\r
   EFI_STRING_ID             StringToken;\r
-  struct _STRING_LIST_NODE  *Next;\r
-} STRING_LIST_NODE;\r
+  STRING_LIST_NODE          *Next;\r
+};\r
 \r
 typedef struct _STRING_DEPOSITORY {\r
   UINTN             TotalNodeNumber;\r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c
index 5ab898959e96c7bb067fcc0d2513a93c34188c13..06fd0e0af775c3eb33aa62abe5ff6ef31d315bd7 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c
@@ -1,7 +1,7 @@
 /** @file\r
   handles console redirection from boot manager\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -864,19 +864,19 @@ IsTerminalDevicePath (
   CopyMem (&TempGuid, &Vendor->Guid, sizeof (EFI_GUID));\r
 \r
   if (CompareGuid (&TempGuid, &TerminalTypeGuid[0])) {\r
-    *Termi      = PC_ANSI;\r
+    *Termi      = TerminalTypePcAnsi;\r
     IsTerminal  = TRUE;\r
   } else {\r
     if (CompareGuid (&TempGuid, &TerminalTypeGuid[1])) {\r
-      *Termi      = VT_100;\r
+      *Termi      = TerminalTypeVt100;\r
       IsTerminal  = TRUE;\r
     } else {\r
       if (CompareGuid (&TempGuid, &TerminalTypeGuid[2])) {\r
-        *Termi      = VT_100_PLUS;\r
+        *Termi      = TerminalTypeVt100Plus;\r
         IsTerminal  = TRUE;\r
       } else {\r
         if (CompareGuid (&TempGuid, &TerminalTypeGuid[3])) {\r
-          *Termi      = VT_UTF8;\r
+          *Termi      = TerminalTypeVtUtf8;\r
           IsTerminal  = TRUE;\r
         } else {\r
           IsTerminal = FALSE;\r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c
index 2cde6e0d0f95832c7e31b7025e1cdd3c3864785c..2eaf9b2d59f4b5510a6ce4d908cf9a4d78117658 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c
@@ -1,7 +1,7 @@
 /** @file\r
   File explorer related functions.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -47,9 +47,9 @@ UpdateFileExplorePage (
       continue;\r
     }\r
 \r
-    if ((NewFileContext->IsDir) || (BOOT_FROM_FILE_STATE == CallbackData->FeCurrentState)) {\r
+    if ((NewFileContext->IsDir) || (FileExplorerStateBootFromFile == CallbackData->FeCurrentState)) {\r
       //\r
-      // Create Text opcode for directory, also create Text opcode for file in BOOT_FROM_FILE_STATE.\r
+      // Create Text opcode for directory, also create Text opcode for file in FileExplorerStateBootFromFile.\r
       //\r
       HiiCreateActionOpCode (\r
         mStartOpCodeHandle,\r
@@ -61,11 +61,11 @@ UpdateFileExplorePage (
         );\r
     } else {\r
       //\r
-      // Create Goto opcode for file in ADD_BOOT_OPTION_STATE or ADD_DRIVER_OPTION_STATE.\r
+      // Create Goto opcode for file in FileExplorerStateAddBootOption or FileExplorerStateAddDriverOptionState.\r
       //\r
-      if (ADD_BOOT_OPTION_STATE == CallbackData->FeCurrentState) {\r
+      if (FileExplorerStateAddBootOption == CallbackData->FeCurrentState) {\r
         FormId = FORM_BOOT_ADD_DESCRIPTION_ID;\r
-      } else if (ADD_DRIVER_OPTION_STATE == CallbackData->FeCurrentState) {\r
+      } else if (FileExplorerStateAddDriverOptionState == CallbackData->FeCurrentState) {\r
         FormId = FORM_DRIVER_ADD_FILE_DESCRIPTION_ID;\r
       }\r
 \r
@@ -119,7 +119,7 @@ UpdateFileExplorer (
 \r
   FileOptionMask    = (UINT16) (FILE_OPTION_MASK & KeyValue);\r
 \r
-  if (UNKNOWN_CONTEXT == CallbackData->FeDisplayContext) {\r
+  if (FileExplorerDisplayUnknown == CallbackData->FeDisplayContext) {\r
     //\r
     // First in, display file system.\r
     //\r
@@ -129,15 +129,15 @@ UpdateFileExplorer (
 \r
     UpdateFileExplorePage (CallbackData, &FsOptionMenu);\r
 \r
-    CallbackData->FeDisplayContext = FILE_SYSTEM;\r
+    CallbackData->FeDisplayContext = FileExplorerDisplayFileSystem;\r
   } else {\r
-    if (FILE_SYSTEM == CallbackData->FeDisplayContext) {\r
+    if (FileExplorerDisplayFileSystem == CallbackData->FeDisplayContext) {\r
       NewMenuEntry = BOpt_GetMenuEntry (&FsOptionMenu, FileOptionMask);\r
-    } else if (DIRECTORY == CallbackData->FeDisplayContext) {\r
+    } else if (FileExplorerDisplayDirectory == CallbackData->FeDisplayContext) {\r
       NewMenuEntry = BOpt_GetMenuEntry (&DirectoryMenu, FileOptionMask);\r
     }\r
 \r
-    CallbackData->FeDisplayContext  = DIRECTORY;\r
+    CallbackData->FeDisplayContext  = FileExplorerDisplayDirectory;\r
 \r
     NewFileContext                  = (BM_FILE_CONTEXT *) NewMenuEntry->VariableContext;\r
 \r
@@ -156,7 +156,7 @@ UpdateFileExplorer (
 \r
     } else {\r
       switch (CallbackData->FeCurrentState) {\r
-      case BOOT_FROM_FILE_STATE:\r
+      case FileExplorerStateBootFromFile:\r
         //\r
         // Here boot from file\r
         //\r
@@ -164,9 +164,9 @@ UpdateFileExplorer (
         ExitFileExplorer = TRUE;\r
         break;\r
 \r
-      case ADD_BOOT_OPTION_STATE:\r
-      case ADD_DRIVER_OPTION_STATE:\r
-        if (ADD_BOOT_OPTION_STATE == CallbackData->FeCurrentState) {\r
+      case FileExplorerStateAddBootOption:\r
+      case FileExplorerStateAddDriverOptionState:\r
+        if (FileExplorerStateAddBootOption == CallbackData->FeCurrentState) {\r
           FormId = FORM_BOOT_ADD_DESCRIPTION_ID;\r
         } else {\r
           FormId = FORM_DRIVER_ADD_FILE_DESCRIPTION_ID;\r
@@ -267,7 +267,7 @@ FileExplorerCallback (
     //\r
     // Apply changes and exit formset\r
     //\r
-    if (ADD_BOOT_OPTION_STATE == Private->FeCurrentState) {\r
+    if (FileExplorerStateAddBootOption == Private->FeCurrentState) {\r
       Status = Var_UpdateBootOption (Private, NvRamMap);\r
       if (EFI_ERROR (Status)) {\r
         return Status;\r
@@ -275,7 +275,7 @@ FileExplorerCallback (
 \r
       BOpt_GetBootOptions (Private);\r
       CreateMenuStringToken (Private, Private->FeHiiHandle, &BootOptionMenu);\r
-    } else if (ADD_DRIVER_OPTION_STATE == Private->FeCurrentState) {\r
+    } else if (FileExplorerStateAddDriverOptionState == Private->FeCurrentState) {\r
       Status = Var_UpdateDriverOption (\r
                 Private,\r
                 Private->FeHiiHandle,\r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/FrontPage.c b/IntelFrameworkModulePkg/Universal/BdsDxe/FrontPage.c
index 5a3443bbe3b49d3bff72de6c46fec4981affd020..2098602b2f729750e84eb436c2b70ab39d054bb2 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/FrontPage.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/FrontPage.c
@@ -620,7 +620,7 @@ GetProducerString (
 }\r
 \r
 /**\r
-  Convert Processor Frequency Data to a string\r
+  Convert Processor Frequency Data to a string.\r
 \r
   @param ProcessorFrequency The frequency data to process\r
   @param String             The string that is created\r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/String.c b/IntelFrameworkModulePkg/Universal/BdsDxe/String.c
index ccabd3239dd7064646c6c6436a604c4a21a98bae..7aeaebb8aa968827e6a9357873e21b8588ddc27b 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/String.c
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/String.c
@@ -1,7 +1,7 @@
 /** @file\r
   String support\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -23,7 +23,7 @@ EFI_GUID mBdsStringPackGuid = {
 };\r
 \r
 /**\r
-  Initialize HII global accessor for string support\r
+  Initialize HII global accessor for string support.\r
 \r
 **/\r
 VOID\r

diff --git a/IntelFrameworkModulePkg/Universal/BdsDxe/String.h b/IntelFrameworkModulePkg/Universal/BdsDxe/String.h
index 4b8efa4345c5b1c019144c46b916eb8b1f1a285f..1b69104a7a23c8e82d1d6c5d2990759c54f705e8 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/BdsDxe/String.h
+++ b/IntelFrameworkModulePkg/Universal/BdsDxe/String.h
@@ -1,7 +1,7 @@
 /** @file\r
   String support\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2004 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -50,7 +50,7 @@ GetStringById (
   );\r
 \r
 /**\r
-  Initialize HII global accessor for string support\r
+  Initialize HII global accessor for string support.\r
 \r
 **/\r
 VOID\r