OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.h

   1 /** @file
   2   Platform BDS customizations include file.
   3
   4   Copyright (c) 2006 - 2016, 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 Module Name:
  14
  15   BdsPlatform.h
  16
  17 Abstract:
  18
  19   Head file for BDS Platform specific code
  20
  21 **/
  22
  23 #ifndef _PLATFORM_SPECIFIC_BDS_PLATFORM_H_
  24 #define _PLATFORM_SPECIFIC_BDS_PLATFORM_H_
  25
  26
  27 #include <PiDxe.h>
  28
  29 #include <IndustryStandard/Bmp.h>
  30 #include <IndustryStandard/Pci.h>
  31 #include <IndustryStandard/Acpi.h>
  32 #include <IndustryStandard/SmBios.h>
  33 #include <IndustryStandard/PeImage.h>
  34
  35 #include <Library/DebugLib.h>
  36 #include <Library/BaseMemoryLib.h>
  37 #include <Library/UefiBootServicesTableLib.h>
  38 #include <Library/UefiRuntimeServicesTableLib.h>
  39 #include <Library/MemoryAllocationLib.h>
  40 #include <Library/BaseLib.h>
  41 #include <Library/PcdLib.h>
  42 #include <Library/PciLib.h>
  43 #include <Library/UefiBootManagerLib.h>
  44 #include <Library/HobLib.h>
  45 #include <Library/UefiLib.h>
  46 #include <Library/DxeServicesTableLib.h>
  47 #include <Library/DevicePathLib.h>
  48 #include <Library/IoLib.h>
  49 #include <Library/NvVarsFileLib.h>
  50 #include <Library/QemuFwCfgLib.h>
  51 #include <Library/QemuBootOrderLib.h>
  52 #include <Library/DxeServicesLib.h>
  53
  54 #include <Protocol/OEMBadging.h>
  55 #include <Protocol/UgaDraw.h>
  56 #include <Protocol/BootLogo.h>
  57 #include <Protocol/Decompress.h>
  58 #include <Protocol/PciIo.h>
  59 #include <Protocol/FirmwareVolume2.h>
  60 #include <Protocol/SimpleFileSystem.h>
  61 #include <Protocol/PciRootBridgeIo.h>
  62 #include <Protocol/S3SaveState.h>
  63 #include <Protocol/DxeSmmReadyToLock.h>
  64 #include <Protocol/LoadedImage.h>
  65
  66 #include <Guid/Acpi.h>
  67 #include <Guid/SmBios.h>
  68 #include <Guid/Mps.h>
  69 #include <Guid/HobList.h>
  70 #include <Guid/GlobalVariable.h>
  71 #include <Guid/EventGroup.h>
  72
  73 #include <OvmfPlatforms.h>
  74
  75 extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformConnectSequence[];
  76 extern ACPI_HID_DEVICE_PATH       gPnpPs2KeyboardDeviceNode;
  77 extern ACPI_HID_DEVICE_PATH       gPnp16550ComPortDeviceNode;
  78 extern UART_DEVICE_PATH           gUartDeviceNode;
  79 extern VENDOR_DEVICE_PATH         gTerminalTypeDeviceNode;
  80
  81 #define PCI_DEVICE_PATH_NODE(Func, Dev) \
  82   { \
  83     { \
  84       HARDWARE_DEVICE_PATH, \
  85       HW_PCI_DP, \
  86       { \
  87         (UINT8) (sizeof (PCI_DEVICE_PATH)), \
  88         (UINT8) ((sizeof (PCI_DEVICE_PATH)) >> 8) \
  89       } \
  90     }, \
  91     (Func), \
  92     (Dev) \
  93   }
  94
  95 #define PNPID_DEVICE_PATH_NODE(PnpId) \
  96   { \
  97     { \
  98       ACPI_DEVICE_PATH, \
  99       ACPI_DP, \
 100       { \
 101         (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), \
 102         (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) \
 103       }, \
 104     }, \
 105     EISA_PNP_ID((PnpId)), \
 106     0 \
 107   }
 108
 109 #define gPciIsaBridge \
 110   PCI_DEVICE_PATH_NODE(0, 0x1f)
 111
 112 #define gP2PBridge \
 113   PCI_DEVICE_PATH_NODE(0, 0x1e)
 114
 115 #define gPnpPs2Keyboard \
 116   PNPID_DEVICE_PATH_NODE(0x0303)
 117
 118 #define gPnp16550ComPort \
 119   PNPID_DEVICE_PATH_NODE(0x0501)
 120
 121 #define gUart \
 122   { \
 123     { \
 124       MESSAGING_DEVICE_PATH, \
 125       MSG_UART_DP, \
 126       { \
 127         (UINT8) (sizeof (UART_DEVICE_PATH)), \
 128         (UINT8) ((sizeof (UART_DEVICE_PATH)) >> 8) \
 129       } \
 130     }, \
 131     0, \
 132     115200, \
 133     8, \
 134     1, \
 135     1 \
 136   }
 137
 138 #define gPcAnsiTerminal \
 139   { \
 140     { \
 141       MESSAGING_DEVICE_PATH, \
 142       MSG_VENDOR_DP, \
 143       { \
 144         (UINT8) (sizeof (VENDOR_DEVICE_PATH)), \
 145         (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) \
 146       } \
 147     }, \
 148     DEVICE_PATH_MESSAGING_PC_ANSI \
 149   }
 150
 151 #define PCI_CLASS_SCC          0x07
 152 #define PCI_SUBCLASS_SERIAL    0x00
 153 #define PCI_IF_16550           0x02
 154 #define IS_PCI_16550SERIAL(_p)           IS_CLASS3 (_p, PCI_CLASS_SCC, PCI_SUBCLASS_SERIAL, PCI_IF_16550)
 155 #define IS_PCI_ISA_PDECODE(_p)        IS_CLASS3 (_p, PCI_CLASS_BRIDGE, PCI_CLASS_BRIDGE_ISA_PDECODE, 0)
 156
 157 typedef struct {
 158   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
 159   UINTN                     ConnectType;
 160 } PLATFORM_CONSOLE_CONNECT_ENTRY;
 161
 162 #define CONSOLE_OUT BIT0
 163 #define CONSOLE_IN  BIT1
 164 #define STD_ERROR   BIT2
 165 extern PLATFORM_CONSOLE_CONNECT_ENTRY  gPlatformConsole[];
 166
 167 //
 168 // Platform BDS Functions
 169 //
 170
 171 VOID
 172 PlatformInitializeConsole (
 173   IN PLATFORM_CONSOLE_CONNECT_ENTRY   *PlatformConsole
 174   );
 175
 176 /**
 177   Loads and boots UEFI Linux via the FwCfg interface.
 178
 179   @retval    EFI_NOT_FOUND - The Linux kernel was not found
 180
 181 **/
 182 EFI_STATUS
 183 TryRunningQemuKernel (
 184   VOID
 185   );
 186
 187 /**
 188   Use SystemTable Conout to stop video based Simple Text Out consoles from going
 189   to the video device. Put up LogoFile on every video device that is a console.
 190
 191   @param[in]  LogoFile   File name of logo to display on the center of the screen.
 192
 193   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.
 194   @retval EFI_UNSUPPORTED Logo not found
 195
 196 **/
 197 EFI_STATUS
 198 EnableQuietBoot (
 199   IN  EFI_GUID  *LogoFile
 200   );
 201
 202 /**
 203   Use SystemTable Conout to turn on video based Simple Text Out consoles. The
 204   Simple Text Out screens will now be synced up with all non video output devices
 205
 206   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
 207
 208 **/
 209 EFI_STATUS
 210 DisableQuietBoot (
 211   VOID
 212   );
 213
 214 #endif // _PLATFORM_SPECIFIC_BDS_PLATFORM_H_