OvmfPkg/Library/PlatformBdsLib/BdsPlatform.h

   1 /** @file
   2   Platform BDS customizations include file.
   3
   4   Copyright (c) 2006 - 2007, 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/GenericBdsLib.h>
  43 #include <Library/PlatformBdsLib.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
  51 #include <Protocol/Decompress.h>
  52 #include <Protocol/PciIo.h>
  53 #include <Protocol/FirmwareVolume2.h>
  54 #include <Protocol/SimpleFileSystem.h>
  55
  56 #include <Guid/Acpi.h>
  57 #include <Guid/SmBios.h>
  58 #include <Guid/Mps.h>
  59 #include <Guid/HobList.h>
  60 #include <Guid/GlobalVariable.h>
  61
  62 #include <OvmfPlatforms.h>
  63
  64 extern BDS_CONSOLE_CONNECT_ENTRY  gPlatformConsole[];
  65 extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformConnectSequence[];
  66 extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformDriverOption[];
  67 extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformRootBridges[];
  68 extern ACPI_HID_DEVICE_PATH       gPnpPs2KeyboardDeviceNode;
  69 extern ACPI_HID_DEVICE_PATH       gPnp16550ComPortDeviceNode;
  70 extern UART_DEVICE_PATH           gUartDeviceNode;
  71 extern VENDOR_DEVICE_PATH         gTerminalTypeDeviceNode;
  72 //
  73 //
  74 //
  75 #define VarConsoleInpDev        L"ConInDev"
  76 #define VarConsoleInp           L"ConIn"
  77 #define VarConsoleOutDev        L"ConOutDev"
  78 #define VarConsoleOut           L"ConOut"
  79 #define VarErrorOutDev          L"ErrOutDev"
  80 #define VarErrorOut             L"ErrOut"
  81
  82 #define PCI_DEVICE_PATH_NODE(Func, Dev) \
  83   { \
  84     { \
  85       HARDWARE_DEVICE_PATH, \
  86       HW_PCI_DP, \
  87       { \
  88         (UINT8) (sizeof (PCI_DEVICE_PATH)), \
  89         (UINT8) ((sizeof (PCI_DEVICE_PATH)) >> 8) \
  90       } \
  91     }, \
  92     (Func), \
  93     (Dev) \
  94   }
  95
  96 #define PNPID_DEVICE_PATH_NODE(PnpId) \
  97   { \
  98     { \
  99       ACPI_DEVICE_PATH, \
 100       ACPI_DP, \
 101       { \
 102         (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), \
 103         (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) \
 104       }, \
 105     }, \
 106     EISA_PNP_ID((PnpId)), \
 107     0 \
 108   }
 109
 110 #define gPciRootBridge \
 111   PNPID_DEVICE_PATH_NODE(0x0A03)
 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 gEndEntire \
 156   { \
 157     END_DEVICE_PATH_TYPE, \
 158     END_ENTIRE_DEVICE_PATH_SUBTYPE, \
 159     { \
 160       END_DEVICE_PATH_LENGTH, \
 161       0 \
 162     } \
 163   }
 164
 165 #define PCI_CLASS_SCC          0x07
 166 #define PCI_SUBCLASS_SERIAL    0x00
 167 #define PCI_IF_16550           0x02
 168 #define IS_PCI_16550SERIAL(_p)           IS_CLASS3 (_p, PCI_CLASS_SCC, PCI_SUBCLASS_SERIAL, PCI_IF_16550)
 169
 170 #define EFI_SYSTEM_TABLE_MAX_ADDRESS 0xFFFFFFFF
 171 #define SYS_TABLE_PAD(ptr) (((~ptr) +1) & 0x07 )
 172
 173 #define IS_PCI_ISA_PDECODE(_p)        IS_CLASS3 (_p, PCI_CLASS_BRIDGE, PCI_CLASS_BRIDGE_ISA_PDECODE, 0)
 174
 175 //
 176 // Platform Root Bridge
 177 //
 178 typedef struct {
 179   ACPI_HID_DEVICE_PATH      PciRootBridge;
 180   EFI_DEVICE_PATH_PROTOCOL  End;
 181 } PLATFORM_ROOT_BRIDGE_DEVICE_PATH;
 182
 183 typedef struct {
 184   ACPI_HID_DEVICE_PATH      PciRootBridge;
 185   PCI_DEVICE_PATH           IsaBridge;
 186   ACPI_HID_DEVICE_PATH      Keyboard;
 187   EFI_DEVICE_PATH_PROTOCOL  End;
 188 } PLATFORM_DUMMY_ISA_KEYBOARD_DEVICE_PATH;
 189
 190 typedef struct {
 191   ACPI_HID_DEVICE_PATH      PciRootBridge;
 192   PCI_DEVICE_PATH           IsaBridge;
 193   ACPI_HID_DEVICE_PATH      IsaSerial;
 194   UART_DEVICE_PATH          Uart;
 195   VENDOR_DEVICE_PATH        TerminalType;
 196   EFI_DEVICE_PATH_PROTOCOL  End;
 197 } PLATFORM_DUMMY_ISA_SERIAL_DEVICE_PATH;
 198
 199 typedef struct {
 200   ACPI_HID_DEVICE_PATH      PciRootBridge;
 201   PCI_DEVICE_PATH           VgaDevice;
 202   EFI_DEVICE_PATH_PROTOCOL  End;
 203 } PLATFORM_DUMMY_PCI_VGA_DEVICE_PATH;
 204
 205 typedef struct {
 206   ACPI_HID_DEVICE_PATH      PciRootBridge;
 207   PCI_DEVICE_PATH           PciBridge;
 208   PCI_DEVICE_PATH           SerialDevice;
 209   UART_DEVICE_PATH          Uart;
 210   VENDOR_DEVICE_PATH        TerminalType;
 211   EFI_DEVICE_PATH_PROTOCOL  End;
 212 } PLATFORM_DUMMY_PCI_SERIAL_DEVICE_PATH;
 213
 214 //
 215 // the short form device path for Usb keyboard
 216 //
 217 #define CLASS_HID           3
 218 #define SUBCLASS_BOOT       1
 219 #define PROTOCOL_KEYBOARD   1
 220
 221 typedef struct {
 222   USB_CLASS_DEVICE_PATH           UsbClass;
 223   EFI_DEVICE_PATH_PROTOCOL        End;
 224 } USB_CLASS_FORMAT_DEVICE_PATH;
 225
 226 extern PLATFORM_ROOT_BRIDGE_DEVICE_PATH  gPlatformRootBridge0;
 227
 228 //
 229 // Platform BDS Functions
 230 //
 231
 232 VOID
 233 PlatformBdsGetDriverOption (
 234   IN LIST_ENTRY               *BdsDriverLists
 235   );
 236
 237 EFI_STATUS
 238 BdsMemoryTest (
 239   EXTENDMEM_COVERAGE_LEVEL Level
 240   );
 241
 242 EFI_STATUS
 243 PlatformBdsShowProgress (
 244   EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
 245   EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
 246   CHAR16                        *Title,
 247   EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
 248   UINTN                         Progress,
 249   UINTN                         PreviousValue
 250   );
 251
 252 VOID
 253 PlatformBdsConnectSequence (
 254   VOID
 255   );
 256
 257 EFI_STATUS
 258 ProcessCapsules (
 259   EFI_BOOT_MODE BootMode
 260   );
 261
 262 EFI_STATUS
 263 PlatformBdsConnectConsole (
 264   IN BDS_CONSOLE_CONNECT_ENTRY   *PlatformConsole
 265   );
 266
 267 EFI_STATUS
 268 PlatformBdsNoConsoleAction (
 269   VOID
 270   );
 271
 272 EFI_STATUS
 273 ConvertMpsTable (
 274   IN OUT  VOID     **Table
 275   );
 276
 277 EFI_STATUS
 278 ConvertSmbiosTable (
 279   IN OUT VOID       **Table
 280   );
 281
 282 EFI_STATUS
 283 ConvertAcpiTable (
 284  IN      UINTN      TableLen,
 285  IN OUT  VOID       **Table
 286   );
 287
 288 EFI_STATUS
 289 ConvertSystemTable (
 290  IN     EFI_GUID   *TableGuid,
 291  IN OUT VOID       **Table
 292   );
 293
 294 VOID
 295 PlatformBdsEnterFrontPage (
 296   IN UINT16                 TimeoutDefault,
 297   IN BOOLEAN                ConnectAllHappened
 298   );
 299
 300 /**
 301   Loads and boots UEFI Linux via the FwCfg interface.
 302
 303   @retval    EFI_NOT_FOUND - The Linux kernel was not found
 304
 305 **/
 306 EFI_STATUS
 307 TryRunningQemuKernel (
 308   VOID
 309   );
 310
 311 #endif // _PLATFORM_SPECIFIC_BDS_PLATFORM_H_