Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Library / PlatformBdsLib.h

diff --git a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
index 3b42564d052a6124ad00cc4ff7261fd09663e574..2e4b0d86c80a88570f3adbcebcd8f6653e7dcb5b 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
@@ -1,8 +1,8 @@
 /** @file\r
-  Platform BDS library definition. Platform package can provide hook library\r
-  instances to implement platform specific behavior.\r
+  Platform BDS library definition. Platform can implement an\r
+  instances to support the platform specific behavior.\r
 \r
-Copyright (c) 2008, Intel Corporation. <BR>\r
+Copyright (c) 2008 - 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
@@ -18,46 +18,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include <Protocol/Bds.h>\r
 #include <Protocol/GenericMemoryTest.h>\r
-\r
-//\r
-// Bds AP Context data\r
-//\r
-#define EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE  SIGNATURE_32 ('B', 'd', 's', 'A')\r
-typedef struct _EFI_BDS_ARCH_PROTOCOL_INSTANCE EFI_BDS_ARCH_PROTOCOL_INSTANCE;\r
-\r
-struct _EFI_BDS_ARCH_PROTOCOL_INSTANCE {\r
-  UINTN                     Signature;\r
-  EFI_HANDLE                Handle;\r
-  EFI_BDS_ARCH_PROTOCOL     Bds;\r
-  ///\r
-  /// Save the current boot mode\r
-  ///\r
-  EFI_BOOT_MODE             BootMode;\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
-  UINT16                    TimeoutDefault;\r
-  ///\r
-  /// Memory Test Level\r
-  ///\r
-  EXTENDMEM_COVERAGE_LEVEL  MemoryTestLevel;\r
-};\r
+#include <Library/GenericBdsLib.h>\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
 EFIAPI\r
 PlatformBdsInit (\r
-  IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData\r
+  VOID\r
   );\r
 \r
 /**\r
@@ -65,7 +36,6 @@ PlatformBdsInit (
   is driven by boot mode. IBV/OEM can customize this code for their specific\r
   policy action.\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
@@ -73,7 +43,6 @@ PlatformBdsInit (
 VOID\r
 EFIAPI\r
 PlatformBdsPolicyBehavior (\r
-  IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData,\r
   IN LIST_ENTRY                      *DriverOptionList,\r
   IN LIST_ENTRY                      *BootOptionList\r
   );\r