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/GenericMemoryTest.h>
  20 #include <Library/GenericBdsLib.h>
  21
  22 /**
  23   Platform Bds initialization. Includes the platform firmware vendor, revision
  24   and so crc check.
  25
  26 **/
  27 VOID
  28 EFIAPI
  29 PlatformBdsInit (
  30   VOID
  31   );
  32
  33 /**
  34   The function will excute with as the platform policy, current policy
  35   is driven by boot mode. IBV/OEM can customize this code for their specific
  36   policy action.
  37
  38   @param  DriverOptionList        The header of the driver option link list
  39   @param  BootOptionList          The header of the boot option link list
  40
  41 **/
  42 VOID
  43 EFIAPI
  44 PlatformBdsPolicyBehavior (
  45   IN LIST_ENTRY                      *DriverOptionList,
  46   IN LIST_ENTRY                      *BootOptionList
  47   );
  48
  49 /**
  50   Hook point after a boot attempt fails.
  51
  52   @param  Option                  Pointer to Boot Option that failed to boot.
  53   @param  Status                  Status returned from failed boot.
  54   @param  ExitData                Exit data returned from failed boot.
  55   @param  ExitDataSize            Exit data size returned from failed boot.
  56
  57 **/
  58 VOID
  59 EFIAPI
  60 PlatformBdsBootFail (
  61   IN  BDS_COMMON_OPTION  *Option,
  62   IN  EFI_STATUS         Status,
  63   IN  CHAR16             *ExitData,
  64   IN  UINTN              ExitDataSize
  65   );
  66
  67 /**
  68   Hook point after a boot attempt succeeds. We don't expect a boot option to
  69   return, so the UEFI 2.0 specification defines that you will default to an
  70   interactive mode and stop processing the BootOrder list in this case. This
  71   is also a platform implementation, and can be customized by an IBV/OEM.
  72
  73   @param  Option                  Pointer to Boot Option that successfully booted.
  74
  75 **/
  76 VOID
  77 EFIAPI
  78 PlatformBdsBootSuccess (
  79   IN  BDS_COMMON_OPTION  *Option
  80   );
  81
  82
  83 /**
  84   This function locks platform flash that is not allowed to be updated during normal boot path.
  85   The flash layout is platform specific.
  86
  87   **/
  88 VOID
  89 EFIAPI
  90 PlatformBdsLockNonUpdatableFlash (
  91   VOID
  92   );
  93
  94 /**
  95   Lock the ConsoleIn device in system table. All key
  96   presses will be ignored until the Password is typed in. The only way to
  97   disable the password is to type it in to a ConIn device.
  98
  99   @param  Password        Password used to lock ConIn device.
 100
 101   @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.
 102   @retval EFI_UNSUPPORTED Password not found
 103
 104 **/
 105 EFI_STATUS
 106 EFIAPI
 107 LockKeyboards (
 108   IN  CHAR16    *Password
 109   );
 110
 111 #endif