Code scrub for PlatformBdsLibNull.inf library instance.

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

diff --git a/MdeModulePkg/Include/Library/PlatformBdsLib.h b/MdeModulePkg/Include/Library/PlatformBdsLib.h
index 4740d7b68e93ebb100b202823ec74d43546bfee1..5b245f6f575c8cef9189e1a662b8765593e21556 100644 (file)
--- a/MdeModulePkg/Include/Library/PlatformBdsLib.h
+++ b/MdeModulePkg/Include/Library/PlatformBdsLib.h
@@ -29,21 +29,21 @@ struct _EFI_BDS_ARCH_PROTOCOL_INSTANCE {
   UINTN                     Signature;\r
   EFI_HANDLE                Handle;\r
   EFI_BDS_ARCH_PROTOCOL     Bds;\r
-  //\r
-  // Save the current boot mode\r
-  //\r
+  ///\r
+  /// Save the current boot mode\r
+  ///\r
   EFI_BOOT_MODE             BootMode;\r
-  //\r
-  // Set true if boot with default settings\r
-  //\r
+  ///\r
+  /// Set true if boot with default settings\r
+  ///\r
   BOOLEAN                   DefaultBoot;\r
-  //\r
-  // The system default timeout for choose the boot option\r
-  //\r
+  ///\r
+  /// The system default timeout for choose the boot option\r
+  ///\r
   UINT16                    TimeoutDefault;\r
-  //\r
-  // Memory Test Level\r
-  //\r
+  ///\r
+  /// Memory Test Level\r
+  ///\r
   EXTENDMEM_COVERAGE_LEVEL  MemoryTestLevel;\r
 };\r
 \r

diff --git a/MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.c b/MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.c
index 5aaa72ab4d0ceddb17567aa852bef784fa3b29b9..0371b60372e7fececa1ec2c3df469ec9cd67b948 100644 (file)
--- a/MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.c
+++ b/MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.c
@@ -1,6 +1,5 @@
 /** @file\r
-  This file include all platform action which can be customized\r
-  by IBV/OEM.\r
+  This file include all platform action which can be customized by IBV/OEM.\r
 \r
 Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -18,191 +17,132 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 // BDS Platform Functions\r
 //\r
+/**\r
+  Platform Bds init. Include the platform firmware vendor, revision\r
+  and so crc check.\r
+\r
+  @param  PrivateData             The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance\r
+\r
+**/\r
 VOID\r
 PlatformBdsInit (\r
   IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Platform Bds init. Incude the platform firmware vendor, revision\r
-  and so crc check.\r
-\r
-Arguments:\r
-\r
-  PrivateData  - The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance\r
-\r
-Returns:\r
-\r
-  None.\r
-\r
---*/\r
 {\r
   return;\r
 }\r
 \r
-EFI_STATUS\r
-PlatformBdsConnectConsole (\r
-  IN BDS_CONSOLE_CONNECT_ENTRY   *PlatformConsole\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
   Connect the predefined platform default console device. Always try to find\r
   and enable the vga device if have.\r
 \r
-Arguments:\r
-\r
-  PlatformConsole         - Predfined platform default console device array.\r
- \r
-Returns:\r
+  @param PlatformConsole          Predfined platform default console device array.\r
 \r
-  EFI_SUCCESS             - Success connect at least one ConIn and ConOut \r
-                            device, there must have one ConOut device is \r
-                            active vga device.\r
-  \r
-  EFI_STATUS              - Return the status of \r
-                            BdsLibConnectAllDefaultConsoles ()\r
+  @retval EFI_SUCCESS             Success connect at least one ConIn and ConOut\r
+                                  device, there must have one ConOut device is\r
+                                  active vga device.\r
+  @return Return the status of BdsLibConnectAllDefaultConsoles ()\r
 \r
---*/\r
+**/\r
+EFI_STATUS\r
+PlatformBdsConnectConsole (\r
+  IN BDS_CONSOLE_CONNECT_ENTRY   *PlatformConsole\r
+  )\r
 {\r
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Connect with predeined platform connect sequence,\r
+  the OEM/IBV can customize with their own connect sequence.\r
+**/\r
 VOID\r
 PlatformBdsConnectSequence (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Connect with predeined platform connect sequence, \r
-  the OEM/IBV can customize with their own connect sequence.\r
-  \r
-Arguments:\r
-\r
-  None.\r
- \r
-Returns:\r
-\r
-  None.\r
-  \r
---*/\r
 {\r
   return;\r
 }\r
 \r
-VOID\r
-PlatformBdsGetDriverOption (\r
-  IN OUT LIST_ENTRY              *BdsDriverLists\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
   Load the predefined driver option, OEM/IBV can customize this\r
   to load their own drivers\r
-  \r
-Arguments:\r
 \r
-  BdsDriverLists  - The header of the driver option link list.\r
- \r
-Returns:\r
+  @param BdsDriverLists  - The header of the driver option link list.\r
 \r
-  None.\r
-  \r
---*/\r
+**/\r
+VOID\r
+PlatformBdsGetDriverOption (\r
+  IN OUT LIST_ENTRY              *BdsDriverLists\r
+  )\r
 {\r
   return;\r
 }\r
 \r
+/**\r
+  Perform the platform diagnostic, such like test memory. OEM/IBV also\r
+  can customize this fuction to support specific platform diagnostic.\r
+\r
+  @param MemoryTestLevel  The memory test intensive level\r
+  @param QuietBoot        Indicate if need to enable the quiet boot\r
+\r
+**/\r
 VOID\r
 PlatformBdsDiagnostics (\r
   IN EXTENDMEM_COVERAGE_LEVEL    MemoryTestLevel,\r
   IN BOOLEAN                     QuietBoot\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Perform the platform diagnostic, such like test memory. OEM/IBV also\r
-  can customize this fuction to support specific platform diagnostic.\r
-  \r
-Arguments:\r
-\r
-  MemoryTestLevel  - The memory test intensive level\r
-  \r
-  QuietBoot        - Indicate if need to enable the quiet boot\r
- \r
-Returns:\r
-\r
-  None.\r
-  \r
---*/\r
 {\r
   return;\r
 }\r
 \r
+/**\r
+  The function will excute with as the platform policy, current policy\r
+  is driven by boot mode. IBV/OEM can customize this code for their specific\r
+  policy action.\r
+\r
+\r
+  @param PrivateData        The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance\r
+  @param DriverOptionList   The header of the driver option link list\r
+  @param BootOptionList     The header of the boot option link list\r
+\r
+**/\r
 VOID\r
 PlatformBdsPolicyBehavior (\r
   IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData,\r
   IN OUT LIST_ENTRY                  *DriverOptionList,\r
   IN OUT LIST_ENTRY                  *BootOptionList\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  The function will excute with as the platform policy, current policy\r
-  is driven by boot mode. IBV/OEM can customize this code for their specific\r
-  policy action.\r
-  \r
-Arguments:\r
-\r
-  PrivateData      - The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance\r
-  \r
-  DriverOptionList - The header of the driver option link list\r
-  \r
-  BootOptionList   - The header of the boot option link list\r
- \r
-Returns:\r
-\r
-  None.\r
-  \r
---*/\r
 {\r
   return ;\r
 }\r
 \r
-VOID\r
-PlatformBdsBootSuccess (\r
-  IN  BDS_COMMON_OPTION   *Option\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
+/**\r
   Hook point after a boot attempt succeeds. We don't expect a boot option to\r
   return, so the EFI 1.0 specification defines that you will default to an\r
   interactive mode and stop processing the BootOrder list in this case. This\r
   is alos a platform implementation and can be customized by IBV/OEM.\r
 \r
-Arguments:\r
-\r
-  Option - Pointer to Boot Option that succeeded to boot.\r
+  @param Option           Pointer to Boot Option that succeeded to boot.\r
 \r
-Returns:\r
-  \r
-  None.\r
-\r
---*/\r
+**/\r
+VOID\r
+PlatformBdsBootSuccess (\r
+  IN  BDS_COMMON_OPTION   *Option\r
+  )\r
 {\r
   return;\r
 }\r
 \r
+/**\r
+  Hook point after a boot attempt fails.\r
+\r
+  @param Option           Pointer to Boot Option that failed to boot.\r
+  @param Status           Status returned from failed boot.\r
+  @param ExitData         Exit data returned from failed boot.\r
+  @param ExitDataSize     Exit data size returned from failed boot.\r
+\r
+**/\r
 VOID\r
 PlatformBdsBootFail (\r
   IN  BDS_COMMON_OPTION  *Option,\r
@@ -210,55 +150,31 @@ PlatformBdsBootFail (
   IN  CHAR16             *ExitData,\r
   IN  UINTN              ExitDataSize\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
-  Hook point after a boot attempt fails.\r
-\r
-Arguments:\r
-  \r
-  Option - Pointer to Boot Option that failed to boot.\r
-\r
-  Status - Status returned from failed boot.\r
-\r
-  ExitData - Exit data returned from failed boot.\r
-\r
-  ExitDataSize - Exit data size returned from failed boot.\r
-\r
-Returns:\r
-  \r
-  None.\r
-\r
---*/\r
 {\r
   return;\r
 }\r
 \r
-EFI_STATUS\r
-PlatformBdsNoConsoleAction (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
+/**\r
   This function is remained for IBV/OEM to do some platform action,\r
   if there no console device can be connected.\r
 \r
-Arguments:\r
-  \r
-  None.\r
-  \r
-Returns:\r
-  \r
-  EFI_SUCCESS      - Direct return success now.\r
+  @return EFI_SUCCESS      Direct return success now.\r
 \r
---*/\r
+**/\r
+EFI_STATUS\r
+PlatformBdsNoConsoleAction (\r
+  VOID\r
+  )\r
 {\r
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  This function locks platform flash that is not allowed to be updated during normal boot path.\r
+  The flash layout is platform specific.\r
+\r
+  @retval EFI_SUCCESS             The non-updatable flash areas.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PlatformBdsLockNonUpdatableFlash (\r

diff --git a/MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.h b/MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.h
index c25735117d66acb57504fa227200797270756fb5..1d4990831fd284799c9312cbf1e6cf5ed56072d9 100644 (file)
--- a/MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.h
+++ b/MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.h
@@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _BDS_PLATFORM_H\r
-#define _BDS_PLATFORM_H\r
+#ifndef _BDS_PLATFORM_H_\r
+#define _BDS_PLATFORM_H_\r
 \r
 #include <PiDxe.h>\r
 \r

diff --git a/MdeModulePkg/Library/PlatformBdsLibNull/PlatformBdsLibNull.inf b/MdeModulePkg/Library/PlatformBdsLibNull/PlatformBdsLibNull.inf
index 630680e0aa12a92c69952f8bf877e1042342de25..9ff7dc73f0a5f5163a1993859398d2957e902b99 100644 (file)
--- a/MdeModulePkg/Library/PlatformBdsLibNull/PlatformBdsLibNull.inf
+++ b/MdeModulePkg/Library/PlatformBdsLibNull/PlatformBdsLibNull.inf
@@ -1,6 +1,7 @@
 #/** @file\r
 #  \r
-#    Component name for module GenericBdsLib\r
+#  Provide NULL implementation for PlatformBdsLib library class interfaces which\r
+#  should be implemented by OEM.\r
 #  \r
 #  Copyright (c) 2007 - 2008, Intel Corporation. <BR>\r
 #  All rights reserved. This program and the accompanying materials\r

diff --git a/MdeModulePkg/Library/PlatformBdsLibNull/PlatformData.c b/MdeModulePkg/Library/PlatformBdsLibNull/PlatformData.c
index 7e4adc0007154c54a21db5e3ee6dc836cd00bc70..a8763487b3f5cf94bdb08ad25e11017fb42be8e7 100644 (file)
--- a/MdeModulePkg/Library/PlatformBdsLibNull/PlatformData.c
+++ b/MdeModulePkg/Library/PlatformBdsLibNull/PlatformData.c
@@ -15,18 +15,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "BdsPlatform.h"\r
 \r
-//\r
-// Predefined platform default time out value\r
-//\r
+///\r
+/// Predefined platform default time out value\r
+///\r
 UINT16                      gPlatformBootTimeOutDefault = 10;\r
 \r
 //\r
 // Platform specific keyboard device path\r
 //\r
 \r
-//\r
-// Predefined platform default console device path\r
-//\r
+///\r
+/// Predefined platform default console device path\r
+///\r
 BDS_CONSOLE_CONNECT_ENTRY   gPlatformConsole[] = {\r
   {\r
     NULL,\r
@@ -34,12 +34,12 @@ BDS_CONSOLE_CONNECT_ENTRY   gPlatformConsole[] = {
   }\r
 };\r
 \r
-//\r
-// Predefined platform specific driver option\r
-//\r
+///\r
+/// Predefined platform specific driver option\r
+///\r
 EFI_DEVICE_PATH_PROTOCOL    *gPlatformDriverOption[] = { NULL };\r
 \r
-//\r
-// Predefined platform connect sequence\r
-//\r
+///\r
+/// Predefined platform connect sequence\r
+///\r
 EFI_DEVICE_PATH_PROTOCOL    *gPlatformConnectSequence[] = { NULL };\r