MdeModulePkg/ResetUtilityLib: Add a new API ResetSystemWithSubtype

[mirror_edk2.git] / OvmfPkg / Library / PlatformBootManagerLib / BdsPlatform.h

/** @file\r
  Platform BDS customizations include file.\r
\r
  Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
Module Name:\r
\r
  BdsPlatform.h\r
\r
Abstract:\r
\r
  Head file for BDS Platform specific code\r
\r
**/\r
\r
#ifndef _PLATFORM_SPECIFIC_BDS_PLATFORM_H_\r
#define _PLATFORM_SPECIFIC_BDS_PLATFORM_H_\r
\r
\r
#include <PiDxe.h>\r
\r
#include <IndustryStandard/Pci.h>\r
#include <IndustryStandard/Acpi.h>\r
#include <IndustryStandard/SmBios.h>\r
#include <IndustryStandard/PeImage.h>\r
#include <IndustryStandard/Virtio095.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/PciLib.h>\r
#include <Library/UefiBootManagerLib.h>\r
#include <Library/BootLogoLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/DxeServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/NvVarsFileLib.h>\r
#include <Library/QemuFwCfgLib.h>\r
#include <Library/QemuFwCfgS3Lib.h>\r
#include <Library/QemuBootOrderLib.h>\r
\r
#include <Protocol/Decompress.h>\r
#include <Protocol/PciIo.h>\r
#include <Protocol/FirmwareVolume2.h>\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/PciRootBridgeIo.h>\r
#include <Protocol/S3SaveState.h>\r
#include <Protocol/DxeSmmReadyToLock.h>\r
#include <Protocol/LoadedImage.h>\r
\r
#include <Guid/Acpi.h>\r
#include <Guid/SmBios.h>\r
#include <Guid/Mps.h>\r
#include <Guid/HobList.h>\r
#include <Guid/GlobalVariable.h>\r
#include <Guid/EventGroup.h>\r
#include <Guid/DebugAgentGuid.h>\r
\r
#include <OvmfPlatforms.h>\r
\r
extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformConnectSequence[];\r
extern ACPI_HID_DEVICE_PATH       gPnpPs2KeyboardDeviceNode;\r
extern ACPI_HID_DEVICE_PATH       gPnp16550ComPortDeviceNode;\r
extern UART_DEVICE_PATH           gUartDeviceNode;\r
extern VENDOR_DEVICE_PATH         gTerminalTypeDeviceNode;\r
\r
#define PCI_DEVICE_PATH_NODE(Func, Dev) \\r
  { \\r
    { \\r
      HARDWARE_DEVICE_PATH, \\r
      HW_PCI_DP, \\r
      { \\r
        (UINT8) (sizeof (PCI_DEVICE_PATH)), \\r
        (UINT8) ((sizeof (PCI_DEVICE_PATH)) >> 8) \\r
      } \\r
    }, \\r
    (Func), \\r
    (Dev) \\r
  }\r
\r
#define PNPID_DEVICE_PATH_NODE(PnpId) \\r
  { \\r
    { \\r
      ACPI_DEVICE_PATH, \\r
      ACPI_DP, \\r
      { \\r
        (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), \\r
        (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) \\r
      }, \\r
    }, \\r
    EISA_PNP_ID((PnpId)), \\r
    0 \\r
  }\r
\r
#define gPciIsaBridge \\r
  PCI_DEVICE_PATH_NODE(0, 0x1f)\r
\r
#define gP2PBridge \\r
  PCI_DEVICE_PATH_NODE(0, 0x1e)\r
\r
#define gPnpPs2Keyboard \\r
  PNPID_DEVICE_PATH_NODE(0x0303)\r
\r
#define gPnp16550ComPort \\r
  PNPID_DEVICE_PATH_NODE(0x0501)\r
\r
#define gUart \\r
  { \\r
    { \\r
      MESSAGING_DEVICE_PATH, \\r
      MSG_UART_DP, \\r
      { \\r
        (UINT8) (sizeof (UART_DEVICE_PATH)), \\r
        (UINT8) ((sizeof (UART_DEVICE_PATH)) >> 8) \\r
      } \\r
    }, \\r
    0, \\r
    115200, \\r
    8, \\r
    1, \\r
    1 \\r
  }\r
\r
#define gPcAnsiTerminal \\r
  { \\r
    { \\r
      MESSAGING_DEVICE_PATH, \\r
      MSG_VENDOR_DP, \\r
      { \\r
        (UINT8) (sizeof (VENDOR_DEVICE_PATH)), \\r
        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) \\r
      } \\r
    }, \\r
    DEVICE_PATH_MESSAGING_PC_ANSI \\r
  }\r
\r
#define gEndEntire \\r
  { \\r
    END_DEVICE_PATH_TYPE, \\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE, \\r
    { \\r
      END_DEVICE_PATH_LENGTH, \\r
      0 \\r
    } \\r
  }\r
\r
#define PCI_CLASS_SCC          0x07\r
#define PCI_SUBCLASS_SERIAL    0x00\r
#define PCI_IF_16550           0x02\r
#define IS_PCI_16550SERIAL(_p)           IS_CLASS3 (_p, PCI_CLASS_SCC, PCI_SUBCLASS_SERIAL, PCI_IF_16550)\r
#define IS_PCI_ISA_PDECODE(_p)        IS_CLASS3 (_p, PCI_CLASS_BRIDGE, PCI_CLASS_BRIDGE_ISA_PDECODE, 0)\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  UINTN                     ConnectType;\r
} PLATFORM_CONSOLE_CONNECT_ENTRY;\r
\r
#define CONSOLE_OUT BIT0\r
#define CONSOLE_IN  BIT1\r
#define STD_ERROR   BIT2\r
extern PLATFORM_CONSOLE_CONNECT_ENTRY  gPlatformConsole[];\r
\r
//\r
// Platform BDS Functions\r
//\r
\r
VOID\r
PlatformInitializeConsole (\r
  IN PLATFORM_CONSOLE_CONNECT_ENTRY   *PlatformConsole\r
  );\r
\r
/**\r
  Loads and boots UEFI Linux via the FwCfg interface.\r
\r
  @retval    EFI_NOT_FOUND - The Linux kernel was not found\r
\r
**/\r
EFI_STATUS\r
TryRunningQemuKernel (\r
  VOID\r
  );\r
\r
#endif // _PLATFORM_SPECIFIC_BDS_PLATFORM_H_\r