Move LockKeyboards API from GenericBdsLib to PlatformBdsLib

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

diff --git a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
index e9e713aa49f9be627189d05d7f8d00b67db2e4ba..dee88a222bdbe4353cfce5b998103df0b8f13f9c 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. A platform can implement \r
+  instances to support 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
@@ -20,45 +20,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/GenericMemoryTest.h>\r
 #include <Library/GenericBdsLib.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
-\r
 /**\r
-  Platform Bds init. Include the platform firmware vendor, revision\r
+  Platform Bds initialization. Includes 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
@@ -66,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
@@ -74,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
@@ -101,9 +69,9 @@ PlatformBdsBootFail (
   Hook point after a boot attempt succeeds. We don't expect a boot option to\r
   return, so the UEFI 2.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
+  is also a platform implementation, and can be customized by an IBV/OEM.\r
 \r
-  @param  Option                  Pointer to Boot Option that succeeded to boot.\r
+  @param  Option                  Pointer to Boot Option that successfully booted.\r
 \r
 **/\r
 VOID\r
@@ -117,11 +85,28 @@ PlatformBdsBootSuccess (
   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
+  **/\r
+VOID\r
 EFIAPI\r
 PlatformBdsLockNonUpdatableFlash (\r
   VOID\r
   );\r
+\r
+/**\r
+  Lock the ConsoleIn device in system table. All key\r
+  presses will be ignored until the Password is typed in. The only way to\r
+  disable the password is to type it in to a ConIn device.\r
+\r
+  @param  Password        Password used to lock ConIn device.\r
+\r
+  @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.\r
+  @retval EFI_UNSUPPORTED Password not found\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+LockKeyboards (\r
+  IN  CHAR16    *Password\r
+  );\r
+\r
 #endif\r