Add function headers & file header for PlatformBdsLib

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

/** @file\r
  Platform BDS library definition. Platform package can provide hook library\r
  instances to implement platform specific behavior.\r
\r
Copyright (c) 2008, 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
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __PLATFORM_BDS_LIB_H_\r
#define __PLATFORM_BDS_LIB_H_\r
\r
#include <PiDxe.h>\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  EFI_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. Incude the platform firmware vendor, revision\r
  and so crc check.\r
\r
  @param  PrivateData             The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance\r
\r
  @return None.\r
\r
**/\r
VOID\r
EFIAPI\r
PlatformBdsInit (\r
  IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData\r
  )\r
;\r
\r
/**\r
  The function will excute with as the platform policy, current policy\r
  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
**/\r
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
;\r
\r
/**\r
  Hook point after a boot attempt fails.\r
\r
  @param  Option                  Pointer to Boot Option that failed to boot.\r
  @param  Status                  Status returned from failed boot.\r
  @param  ExitData                Exit data returned from failed boot.\r
  @param  ExitDataSize            Exit data size returned from failed boot.\r
\r
  @return None.\r
\r
**/\r
VOID\r
EFIAPI\r
PlatformBdsBootFail (\r
  IN  BDS_COMMON_OPTION  *Option,\r
  IN  EFI_STATUS         Status,\r
  IN  CHAR16             *ExitData,\r
  IN  UINTN              ExitDataSize\r
  )\r
;\r
\r
/**\r
  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
\r
  @param  Option                  Pointer to Boot Option that succeeded to boot.\r
\r
**/\r
VOID\r
EFIAPI\r
PlatformBdsBootSuccess (\r
  IN  BDS_COMMON_OPTION *Option\r
  )\r
;\r
\r
\r
/**\r
  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
  @retval Others                  Some error occurs when locking non-updatable flash areas.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PlatformBdsLockNonUpdatableFlash (\r
  VOID\r
  )\r
;\r
#endif\r