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