MdeModulePkg/Include/Library/PlatformBdsLib.h

   1 /** @file
   2   Platform BDS library definition. Platform package can provide hook library
   3   instances to implement platform specific behavior.
   4
   5 Copyright (c) 2008, 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 <PiDxe.h>
  20 #include <Protocol/Bds.h>
  21 #include <Protocol/GenericMemoryTest.h>
  22
  23 //
  24 // Bds AP Context data
  25 //
  26 #define EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE  EFI_SIGNATURE_32 ('B', 'd', 's', 'A')
  27 typedef struct _EFI_BDS_ARCH_PROTOCOL_INSTANCE EFI_BDS_ARCH_PROTOCOL_INSTANCE;
  28
  29 struct _EFI_BDS_ARCH_PROTOCOL_INSTANCE {
  30   UINTN                     Signature;
  31   EFI_HANDLE                Handle;
  32   EFI_BDS_ARCH_PROTOCOL     Bds;
  33   //
  34   // Save the current boot mode
  35   //
  36   EFI_BOOT_MODE             BootMode;
  37   //
  38   // Set true if boot with default settings
  39   //
  40   BOOLEAN                   DefaultBoot;
  41   //
  42   // The system default timeout for choose the boot option
  43   //
  44   UINT16                    TimeoutDefault;
  45   //
  46   // Memory Test Level
  47   //
  48   EXTENDMEM_COVERAGE_LEVEL  MemoryTestLevel;
  49 };
  50
  51 /**
  52   Platform Bds init. Incude the platform firmware vendor, revision
  53   and so crc check.
  54
  55   @param  PrivateData             The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance
  56
  57 **/
  58 VOID
  59 EFIAPI
  60 PlatformBdsInit (
  61   IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData
  62   );
  63
  64 /**
  65   The function will excute with as the platform policy, current policy
  66   is driven by boot mode. IBV/OEM can customize this code for their specific
  67   policy action.
  68
  69   @param  PrivateData             The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance
  70   @param  DriverOptionList        The header of the driver option link list
  71   @param  BootOptionList          The header of the boot option link list
  72
  73 **/
  74 VOID
  75 EFIAPI
  76 PlatformBdsPolicyBehavior (
  77   IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData,
  78   IN LIST_ENTRY                      *DriverOptionList,
  79   IN LIST_ENTRY                      *BootOptionList
  80   );
  81
  82 /**
  83   Hook point after a boot attempt fails.
  84
  85   @param  Option                  Pointer to Boot Option that failed to boot.
  86   @param  Status                  Status returned from failed boot.
  87   @param  ExitData                Exit data returned from failed boot.
  88   @param  ExitDataSize            Exit data size returned from failed boot.
  89
  90 **/
  91 VOID
  92 EFIAPI
  93 PlatformBdsBootFail (
  94   IN  BDS_COMMON_OPTION  *Option,
  95   IN  EFI_STATUS         Status,
  96   IN  CHAR16             *ExitData,
  97   IN  UINTN              ExitDataSize
  98   );
  99
 100 /**
 101   Hook point after a boot attempt succeeds. We don't expect a boot option to
 102   return, so the UEFI 2.0 specification defines that you will default to an
 103   interactive mode and stop processing the BootOrder list in this case. This
 104   is alos a platform implementation and can be customized by IBV/OEM.
 105
 106   @param  Option                  Pointer to Boot Option that succeeded to boot.
 107
 108 **/
 109 VOID
 110 EFIAPI
 111 PlatformBdsBootSuccess (
 112   IN  BDS_COMMON_OPTION *Option
 113   );
 114
 115
 116 /**
 117   This function locks platform flash that is not allowed to be updated during normal boot path.
 118   The flash layout is platform specific.
 119
 120   @retval EFI_SUCCESS             The non-updatable flash areas.
 121 **/
 122 EFI_STATUS
 123 EFIAPI
 124 PlatformBdsLockNonUpdatableFlash (
 125   VOID
 126   );
 127 #endif