CorebootPayloadPkg/Library/PlatformBootManagerLib/PlatformBootManager.h

   1 /**@file
   2    Head file for BDS Platform specific code
   3
   4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 **/
  13
  14 #ifndef _PLATFORM_BOOT_MANAGER_H
  15 #define _PLATFORM_BOOT_MANAGER_H
  16
  17 #include <PiDxe.h>
  18 #include <Protocol/LoadedImage.h>
  19
  20 #include <Library/DebugLib.h>
  21 #include <Library/BaseMemoryLib.h>
  22 #include <Library/UefiBootServicesTableLib.h>
  23 #include <Library/UefiRuntimeServicesTableLib.h>
  24 #include <Library/MemoryAllocationLib.h>
  25 #include <Library/BaseLib.h>
  26 #include <Library/UefiRuntimeServicesTableLib.h>
  27 #include <Library/UefiLib.h>
  28 #include <Library/UefiBootManagerLib.h>
  29 #include <Library/PcdLib.h>
  30 #include <Library/DevicePathLib.h>
  31 #include <Library/HiiLib.h>
  32 #include <Library/PrintLib.h>
  33 #include <Library/DxeServicesLib.h>
  34 #include <Library/BootLogoLib.h>
  35
  36
  37 typedef struct {
  38   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
  39   UINTN                     ConnectType;
  40 } PLATFORM_CONSOLE_CONNECT_ENTRY;
  41
  42 extern PLATFORM_CONSOLE_CONNECT_ENTRY  gPlatformConsole[];
  43
  44 #define gEndEntire \
  45   { \
  46     END_DEVICE_PATH_TYPE,\
  47     END_ENTIRE_DEVICE_PATH_SUBTYPE,\
  48     END_DEVICE_PATH_LENGTH,\
  49     0\
  50   }
  51
  52 #define CONSOLE_OUT BIT0
  53 #define CONSOLE_IN  BIT1
  54 #define STD_ERROR   BIT2
  55
  56 typedef struct {
  57   VENDOR_DEVICE_PATH  VendorDevicePath;
  58   UINT32              Instance;
  59 } WIN_NT_VENDOR_DEVICE_PATH_NODE;
  60
  61 //
  62 // Below is the platform console device path
  63 //
  64 typedef struct {
  65   VENDOR_DEVICE_PATH              NtBus;
  66   WIN_NT_VENDOR_DEVICE_PATH_NODE  SerialDevice;
  67   UART_DEVICE_PATH                Uart;
  68   VENDOR_DEVICE_PATH              TerminalType;
  69   EFI_DEVICE_PATH_PROTOCOL        End;
  70 } NT_ISA_SERIAL_DEVICE_PATH;
  71
  72 typedef struct {
  73   VENDOR_DEVICE_PATH              NtBus;
  74   WIN_NT_VENDOR_DEVICE_PATH_NODE  NtGopDevice;
  75   EFI_DEVICE_PATH_PROTOCOL        End;
  76 } NT_PLATFORM_GOP_DEVICE_PATH;
  77
  78 /**
  79   Use SystemTable Conout to stop video based Simple Text Out consoles from going
  80   to the video device. Put up LogoFile on every video device that is a console.
  81
  82   @param[in]  LogoFile   File name of logo to display on the center of the screen.
  83
  84   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.
  85   @retval EFI_UNSUPPORTED Logo not found
  86
  87 **/
  88 EFI_STATUS
  89 PlatformBootManagerEnableQuietBoot (
  90   IN  EFI_GUID  *LogoFile
  91 );
  92
  93 /**
  94   Use SystemTable Conout to turn on video based Simple Text Out consoles. The
  95   Simple Text Out screens will now be synced up with all non video output devices
  96
  97   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
  98
  99 **/
 100 EFI_STATUS
 101 PlatformBootManagerDisableQuietBoot (
 102   VOID
 103 );
 104
 105 /**
 106   Show progress bar with title above it. It only works in Graphics mode.
 107
 108   @param TitleForeground Foreground color for Title.
 109   @param TitleBackground Background color for Title.
 110   @param Title           Title above progress bar.
 111   @param ProgressColor   Progress bar color.
 112   @param Progress        Progress (0-100)
 113   @param PreviousValue   The previous value of the progress.
 114
 115   @retval  EFI_STATUS       Success update the progress bar
 116
 117 **/
 118 EFI_STATUS
 119 PlatformBootManagerShowProgress (
 120   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
 121   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
 122   IN CHAR16                        *Title,
 123   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
 124   IN UINTN                         Progress,
 125   IN UINTN                         PreviousValue
 126 );
 127
 128 #endif // _PLATFORM_BOOT_MANAGER_H