IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h

   1 /** @file
   2   Platform BDS library definition. A platform can implement
   3   instances to support platform-specific behavior.
   4
   5 Copyright (c) 2008 - 2009, Intel Corporation. <BR>
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __PLATFORM_BDS_LIB_H_
  17 #define __PLATFORM_BDS_LIB_H_
  18
  19 #include <Protocol/Bds.h>
  20 #include <Protocol/GenericMemoryTest.h>
  21 #include <Library/GenericBdsLib.h>
  22
  23 /**
  24   Platform Bds initialization. Includes the platform firmware vendor, revision
  25   and so crc check.
  26
  27 **/
  28 VOID
  29 EFIAPI
  30 PlatformBdsInit (
  31   VOID
  32   );
  33
  34 /**
  35   The function will excute with as the platform policy, current policy
  36   is driven by boot mode. IBV/OEM can customize this code for their specific
  37   policy action.
  38
  39   @param  DriverOptionList        The header of the driver option link list
  40   @param  BootOptionList          The header of the boot option link list
  41
  42 **/
  43 VOID
  44 EFIAPI
  45 PlatformBdsPolicyBehavior (
  46   IN LIST_ENTRY                      *DriverOptionList,
  47   IN LIST_ENTRY                      *BootOptionList
  48   );
  49
  50 /**
  51   Hook point after a boot attempt fails.
  52
  53   @param  Option                  Pointer to Boot Option that failed to boot.
  54   @param  Status                  Status returned from failed boot.
  55   @param  ExitData                Exit data returned from failed boot.
  56   @param  ExitDataSize            Exit data size returned from failed boot.
  57
  58 **/
  59 VOID
  60 EFIAPI
  61 PlatformBdsBootFail (
  62   IN  BDS_COMMON_OPTION  *Option,
  63   IN  EFI_STATUS         Status,
  64   IN  CHAR16             *ExitData,
  65   IN  UINTN              ExitDataSize
  66   );
  67
  68 /**
  69   Hook point after a boot attempt succeeds. We don't expect a boot option to
  70   return, so the UEFI 2.0 specification defines that you will default to an
  71   interactive mode and stop processing the BootOrder list in this case. This
  72   is also a platform implementation, and can be customized by an IBV/OEM.
  73
  74   @param  Option                  Pointer to Boot Option that successfully booted.
  75
  76 **/
  77 VOID
  78 EFIAPI
  79 PlatformBdsBootSuccess (
  80   IN  BDS_COMMON_OPTION *Option
  81   );
  82
  83
  84 /**
  85   This function locks platform flash that is not allowed to be updated during normal boot path.
  86   The flash layout is platform specific.
  87
  88   **/
  89 VOID
  90 EFIAPI
  91 PlatformBdsLockNonUpdatableFlash (
  92   VOID
  93   );
  94
  95 /**
  96   Lock the ConsoleIn device in system table. All key
  97   presses will be ignored until the Password is typed in. The only way to
  98   disable the password is to type it in to a ConIn device.
  99
 100   @param  Password        Password used to lock ConIn device.
 101
 102   @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.
 103   @retval EFI_UNSUPPORTED Password not found
 104
 105 **/
 106 EFI_STATUS
 107 EFIAPI
 108 LockKeyboards (
 109   IN  CHAR16    *Password
 110   );
 111
 112 #endif