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/Pci.h>
  30 #include <IndustryStandard/Acpi.h>
  31 #include <IndustryStandard/SmBios.h>
  32 #include <IndustryStandard/PeImage.h>
  33
  34 #include <Library/DebugLib.h>
  35 #include <Library/BaseMemoryLib.h>
  36 #include <Library/UefiBootServicesTableLib.h>
  37 #include <Library/UefiRuntimeServicesTableLib.h>
  38 #include <Library/MemoryAllocationLib.h>
  39 #include <Library/BaseLib.h>
  40 #include <Library/PcdLib.h>
  41 #include <Library/PciLib.h>
  42 #include <Library/UefiBootManagerLib.h>
  43 #include <Library/HobLib.h>
  44 #include <Library/UefiLib.h>
  45 #include <Library/DxeServicesTableLib.h>
  46 #include <Library/DevicePathLib.h>
  47 #include <Library/IoLib.h>
  48 #include <Library/NvVarsFileLib.h>
  49 #include <Library/QemuFwCfgLib.h>
  50
  51 #include <Protocol/Decompress.h>
  52 #include <Protocol/PciIo.h>
  53 #include <Protocol/FirmwareVolume2.h>
  54 #include <Protocol/SimpleFileSystem.h>
  55 #include <Protocol/PciRootBridgeIo.h>
  56 #include <Protocol/S3SaveState.h>
  57 #include <Protocol/DxeSmmReadyToLock.h>
  58
  59 #include <Guid/Acpi.h>
  60 #include <Guid/SmBios.h>
  61 #include <Guid/Mps.h>
  62 #include <Guid/HobList.h>
  63 #include <Guid/GlobalVariable.h>
  64 #include <Guid/EventGroup.h>
  65
  66 #include <OvmfPlatforms.h>
  67
  68 extern BDS_CONSOLE_CONNECT_ENTRY  gPlatformConsole[];
  69 extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformConnectSequence[];
  70 extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformDriverOption[];
  71 extern ACPI_HID_DEVICE_PATH       gPnpPs2KeyboardDeviceNode;
  72 extern ACPI_HID_DEVICE_PATH       gPnp16550ComPortDeviceNode;
  73 extern UART_DEVICE_PATH           gUartDeviceNode;
  74 extern VENDOR_DEVICE_PATH         gTerminalTypeDeviceNode;
  75 //
  76 //
  77 //
  78 #define VarConsoleInpDev        L"ConInDev"
  79 #define VarConsoleInp           L"ConIn"
  80 #define VarConsoleOutDev        L"ConOutDev"
  81 #define VarConsoleOut           L"ConOut"
  82 #define VarErrorOutDev          L"ErrOutDev"
  83 #define VarErrorOut             L"ErrOut"
  84
  85 #define PCI_DEVICE_PATH_NODE(Func, Dev) \
  86   { \
  87     { \
  88       HARDWARE_DEVICE_PATH, \
  89       HW_PCI_DP, \
  90       { \
  91         (UINT8) (sizeof (PCI_DEVICE_PATH)), \
  92         (UINT8) ((sizeof (PCI_DEVICE_PATH)) >> 8) \
  93       } \
  94     }, \
  95     (Func), \
  96     (Dev) \
  97   }
  98
  99 #define PNPID_DEVICE_PATH_NODE(PnpId) \
 100   { \
 101     { \
 102       ACPI_DEVICE_PATH, \
 103       ACPI_DP, \
 104       { \
 105         (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), \
 106         (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) \
 107       }, \
 108     }, \
 109     EISA_PNP_ID((PnpId)), \
 110     0 \
 111   }
 112
 113 #define gPciIsaBridge \
 114   PCI_DEVICE_PATH_NODE(0, 0x1f)
 115
 116 #define gP2PBridge \
 117   PCI_DEVICE_PATH_NODE(0, 0x1e)
 118
 119 #define gPnpPs2Keyboard \
 120   PNPID_DEVICE_PATH_NODE(0x0303)
 121
 122 #define gPnp16550ComPort \
 123   PNPID_DEVICE_PATH_NODE(0x0501)
 124
 125 #define gUart \
 126   { \
 127     { \
 128       MESSAGING_DEVICE_PATH, \
 129       MSG_UART_DP, \
 130       { \
 131         (UINT8) (sizeof (UART_DEVICE_PATH)), \
 132         (UINT8) ((sizeof (UART_DEVICE_PATH)) >> 8) \
 133       } \
 134     }, \
 135     0, \
 136     115200, \
 137     8, \
 138     1, \
 139     1 \
 140   }
 141
 142 #define gPcAnsiTerminal \
 143   { \
 144     { \
 145       MESSAGING_DEVICE_PATH, \
 146       MSG_VENDOR_DP, \
 147       { \
 148         (UINT8) (sizeof (VENDOR_DEVICE_PATH)), \
 149         (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) \
 150       } \
 151     }, \
 152     DEVICE_PATH_MESSAGING_PC_ANSI \
 153   }
 154
 155 #define PCI_CLASS_SCC          0x07
 156 #define PCI_SUBCLASS_SERIAL    0x00
 157 #define PCI_IF_16550           0x02
 158 #define IS_PCI_16550SERIAL(_p)           IS_CLASS3 (_p, PCI_CLASS_SCC, PCI_SUBCLASS_SERIAL, PCI_IF_16550)
 159
 160 #define EFI_SYSTEM_TABLE_MAX_ADDRESS 0xFFFFFFFF
 161 #define SYS_TABLE_PAD(ptr) (((~ptr) +1) & 0x07 )
 162
 163 #define IS_PCI_ISA_PDECODE(_p)        IS_CLASS3 (_p, PCI_CLASS_BRIDGE, PCI_CLASS_BRIDGE_ISA_PDECODE, 0)
 164
 165 typedef struct {
 166   ACPI_HID_DEVICE_PATH      PciRootBridge;
 167   PCI_DEVICE_PATH           IsaBridge;
 168   ACPI_HID_DEVICE_PATH      Keyboard;
 169   EFI_DEVICE_PATH_PROTOCOL  End;
 170 } PLATFORM_DUMMY_ISA_KEYBOARD_DEVICE_PATH;
 171
 172 typedef struct {
 173   ACPI_HID_DEVICE_PATH      PciRootBridge;
 174   PCI_DEVICE_PATH           IsaBridge;
 175   ACPI_HID_DEVICE_PATH      IsaSerial;
 176   UART_DEVICE_PATH          Uart;
 177   VENDOR_DEVICE_PATH        TerminalType;
 178   EFI_DEVICE_PATH_PROTOCOL  End;
 179 } PLATFORM_DUMMY_ISA_SERIAL_DEVICE_PATH;
 180
 181 typedef struct {
 182   ACPI_HID_DEVICE_PATH      PciRootBridge;
 183   PCI_DEVICE_PATH           VgaDevice;
 184   EFI_DEVICE_PATH_PROTOCOL  End;
 185 } PLATFORM_DUMMY_PCI_VGA_DEVICE_PATH;
 186
 187 typedef struct {
 188   ACPI_HID_DEVICE_PATH      PciRootBridge;
 189   PCI_DEVICE_PATH           PciBridge;
 190   PCI_DEVICE_PATH           SerialDevice;
 191   UART_DEVICE_PATH          Uart;
 192   VENDOR_DEVICE_PATH        TerminalType;
 193   EFI_DEVICE_PATH_PROTOCOL  End;
 194 } PLATFORM_DUMMY_PCI_SERIAL_DEVICE_PATH;
 195
 196 //
 197 // the short form device path for Usb keyboard
 198 //
 199 #define CLASS_HID           3
 200 #define SUBCLASS_BOOT       1
 201 #define PROTOCOL_KEYBOARD   1
 202
 203 typedef struct {
 204   USB_CLASS_DEVICE_PATH           UsbClass;
 205   EFI_DEVICE_PATH_PROTOCOL        End;
 206 } USB_CLASS_FORMAT_DEVICE_PATH;
 207
 208 //
 209 // Platform BDS Functions
 210 //
 211
 212 VOID
 213 PlatformBdsGetDriverOption (
 214   IN LIST_ENTRY               *BdsDriverLists
 215   );
 216
 217 EFI_STATUS
 218 BdsMemoryTest (
 219   EXTENDMEM_COVERAGE_LEVEL Level
 220   );
 221
 222 EFI_STATUS
 223 PlatformBdsShowProgress (
 224   EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
 225   EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
 226   CHAR16                        *Title,
 227   EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
 228   UINTN                         Progress,
 229   UINTN                         PreviousValue
 230   );
 231
 232 VOID
 233 PlatformBdsConnectSequence (
 234   VOID
 235   );
 236
 237 EFI_STATUS
 238 ProcessCapsules (
 239   EFI_BOOT_MODE BootMode
 240   );
 241
 242 EFI_STATUS
 243 PlatformBdsConnectConsole (
 244   IN BDS_CONSOLE_CONNECT_ENTRY   *PlatformConsole
 245   );
 246
 247 EFI_STATUS
 248 PlatformBdsNoConsoleAction (
 249   VOID
 250   );
 251
 252 EFI_STATUS
 253 ConvertMpsTable (
 254   IN OUT  VOID     **Table
 255   );
 256
 257 EFI_STATUS
 258 ConvertSmbiosTable (
 259   IN OUT VOID       **Table
 260   );
 261
 262 EFI_STATUS
 263 ConvertAcpiTable (
 264  IN      UINTN      TableLen,
 265  IN OUT  VOID       **Table
 266   );
 267
 268 EFI_STATUS
 269 ConvertSystemTable (
 270  IN     EFI_GUID   *TableGuid,
 271  IN OUT VOID       **Table
 272   );
 273
 274 VOID
 275 PlatformBdsEnterFrontPage (
 276   IN UINT16                 TimeoutDefault,
 277   IN BOOLEAN                ConnectAllHappened
 278   );
 279
 280 /**
 281   Loads and boots UEFI Linux via the FwCfg interface.
 282
 283   @retval    EFI_NOT_FOUND - The Linux kernel was not found
 284
 285 **/
 286 EFI_STATUS
 287 TryRunningQemuKernel (
 288   VOID
 289   );
 290
 291 #endif // _PLATFORM_SPECIFIC_BDS_PLATFORM_H_