OvmfPkg/Include/Library/PlatformBmPrintScLib.h

   1 /** @file
   2   Register a status code handler for printing the Boot Manager's LoadImage()
   3   and StartImage() preparations, and return codes, to the UEFI console.
   4
   5   This feature enables users that are not accustomed to analyzing the firmware
   6   log to glean some information about UEFI boot option processing (loading and
   7   starting).
   8
   9   Copyright (C) 2019, Red Hat, Inc.
  10
  11   SPDX-License-Identifier: BSD-2-Clause-Patent
  12 **/
  13
  14 #ifndef __PLATFORM_BM_PRINT_SC_LIB__
  15 #define __PLATFORM_BM_PRINT_SC_LIB__
  16
  17 #include <Uefi/UefiBaseType.h>
  18
  19 /**
  20   Register a status code handler for printing the Boot Manager's LoadImage()
  21   and StartImage() preparations, and return codes, to the UEFI console.
  22
  23   @retval EFI_SUCCESS  The status code handler has been successfully
  24                        registered.
  25
  26   @return              Error codes propagated from boot services and from
  27                        EFI_RSC_HANDLER_PROTOCOL.
  28 **/
  29 EFI_STATUS
  30 EFIAPI
  31 PlatformBmPrintScRegisterHandler (
  32   VOID
  33   );
  34
  35 #endif // __PLATFORM_BM_PRINT_SC_LIB__