Committing changes to the comments, to improve code documentation.

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

/** @file\r
  Platform BDS library definition. Platform can implement an\r
  instances to support the platform specific behavior.\r
\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
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 <Protocol/Bds.h>\r
#include <Protocol/GenericMemoryTest.h>\r
#include <Library/GenericBdsLib.h>\r
\r
/**\r
  Platform Bds init. Include the platform firmware vendor, revision\r
  and so crc check.\r
\r
**/\r
VOID\r
EFIAPI\r
PlatformBdsInit (\r
  VOID\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  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 LIST_ENTRY                      *DriverOptionList,\r
  IN LIST_ENTRY                      *BootOptionList\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
**/\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
  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
  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
EFIAPI\r
PlatformBdsLockNonUpdatableFlash (\r
  VOID\r
  );\r
#endif\r