MdeModulePkg/Include/Library/PlatformBootManagerLib.h

   1 /** @file
   2   Platform Boot Manager library definition. A platform can implement
   3   instances to support platform-specific behavior.
   4
   5 Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10
  11 #ifndef __PLATFORM_BOOT_MANAGER_LIB_H_
  12 #define __PLATFORM_BOOT_MANAGER_LIB_H_
  13 #include <Library/UefiBootManagerLib.h>
  14
  15 /**
  16   Do the platform specific action before the console is connected.
  17
  18   Such as:
  19     Update console variable;
  20     Register new Driver#### or Boot####;
  21     Signal ReadyToLock event.
  22 **/
  23 VOID
  24 EFIAPI
  25 PlatformBootManagerBeforeConsole (
  26   VOID
  27   );
  28
  29 /**
  30   Do the platform specific action after the console is connected.
  31
  32   Such as:
  33     Dynamically switch output mode;
  34     Signal console ready platform customized event;
  35     Run diagnostics like memory testing;
  36     Connect certain devices;
  37     Dispatch aditional option roms.
  38 **/
  39 VOID
  40 EFIAPI
  41 PlatformBootManagerAfterConsole (
  42   VOID
  43   );
  44
  45 /**
  46   This function is called each second during the boot manager waits the timeout.
  47
  48   @param TimeoutRemain  The remaining timeout.
  49 **/
  50 VOID
  51 EFIAPI
  52 PlatformBootManagerWaitCallback (
  53   UINT16          TimeoutRemain
  54   );
  55
  56 /**
  57   The function is called when no boot option could be launched,
  58   including platform recovery options and options pointing to applications
  59   built into firmware volumes.
  60
  61   If this function returns, BDS attempts to enter an infinite loop.
  62 **/
  63 VOID
  64 EFIAPI
  65 PlatformBootManagerUnableToBoot (
  66   VOID
  67   );
  68
  69 #endif