OvmfPkg/Library/PlatformBdsLib/BdsPlatform.h

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