Remove CommonHeader.h for BdsPlatformDxe driver in Nt32Pkg.

[mirror_edk2.git] / Nt32Pkg / PlatformBdsDxe / BdsPlatform.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \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 _BDS_PLATFORM_H\r
#define _BDS_PLATFORM_H\r
\r
#include <PiDxe.h>\r
#include <Common/MaxBbsEntries.h>\r
#include <Protocol/FormCallbackFramework.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/LoadFile.h>\r
#include <Protocol/CpuIo.h>\r
#include <Protocol/Bds.h>\r
#include <Protocol/DataHub.h>\r
#include <Protocol/FormBrowserFramework.h>\r
#include <Protocol/UgaDraw.h>\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/ConsoleControl.h>\r
#include <Protocol/GenericMemoryTest.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/HiiFramework.h>\r
#include <Protocol/SerialIo.h>\r
#include <Protocol/LegacyBios.h>\r
#include <Protocol/Performance.h>\r
#include <Guid/PcAnsi.h>\r
#include <Guid/DataHubRecords.h>\r
#include <Guid/Bmp.h>\r
#include <Guid/FileInfo.h>\r
#include <Guid/BootState.h>\r
#include <Guid/FileSystemVolumeLabelInfo.h>\r
#include <Guid/GenericPlatformVariable.h>\r
#include <Guid/GlobalVariable.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/BaseLib.h>\r
#include <Library/GraphicsLib.h>\r
#include <Library/DxeServicesTableLib.h>\r
#include <Library/PerformanceLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/IfrSupportLibFramework.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/EdkGenericBdsLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/HiiLibFramework.h>\r
#include <Library/PeCoffLib.h>\r
#include <Library/PcdLib.h>\r
\r
//\r
// The rest of the includes\r
//\r
#include <Common/FirmwareRevision.h>\r
\r
extern UINT8 PlatformBdsStrings[];\r
\r
#include "IndustryStandard/Pci22.h"\r
\r
extern BDS_CONSOLE_CONNECT_ENTRY  gPlatformConsole[];\r
extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformConnectSequence[];\r
extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformDriverOption[];\r
\r
#define gEndEntire \\r
  { \\r
    END_DEVICE_PATH_TYPE,\\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\\r
    END_DEVICE_PATH_LENGTH,\\r
    0\\r
  }\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH  VendorDevicePath;\r
  UINT32              Instance;\r
} WIN_NT_VENDOR_DEVICE_PATH_NODE;\r
\r
//\r
// Below is the platform console device path\r
//\r
typedef struct {\r
  VENDOR_DEVICE_PATH              NtBus;\r
  WIN_NT_VENDOR_DEVICE_PATH_NODE  SerialDevice;\r
  UART_DEVICE_PATH                Uart;\r
  VENDOR_DEVICE_PATH              TerminalType;\r
  EFI_DEVICE_PATH_PROTOCOL        End;\r
} NT_ISA_SERIAL_DEVICE_PATH;\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH              NtBus;\r
  WIN_NT_VENDOR_DEVICE_PATH_NODE  NtUgaDevice;\r
  EFI_DEVICE_PATH_PROTOCOL        End;\r
} NT_PLATFORM_UGA_DEVICE_PATH;\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH              NtBus;\r
  WIN_NT_VENDOR_DEVICE_PATH_NODE  NtGopDevice;\r
  EFI_DEVICE_PATH_PROTOCOL        End;\r
} NT_PLATFORM_GOP_DEVICE_PATH;\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH              NtBus;\r
  WIN_NT_VENDOR_DEVICE_PATH_NODE  NtCpuModelDevice;\r
  EFI_DEVICE_PATH_PROTOCOL        End;\r
} NT_PLATFORM_CPU_MODEL_VIRTUAL_DEVICE_PATH;\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH              NtBus;\r
  WIN_NT_VENDOR_DEVICE_PATH_NODE  NtCpuSpeedDevice;\r
  EFI_DEVICE_PATH_PROTOCOL        End;\r
} NT_PLATFORM_CPU_SPEED_VIRTUAL_DEVICE_PATH;\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH              NtBus;\r
  WIN_NT_VENDOR_DEVICE_PATH_NODE  NtMemoryDeivce;\r
  EFI_DEVICE_PATH_PROTOCOL        End;\r
} NT_PLATFORM_MEMORY_VIRTUAL_DEVICE_PATH;\r
\r
//\r
// Platform BDS Functions\r
//\r
VOID\r
PlatformBdsInit (\r
  IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData\r
  )\r
;\r
\r
VOID\r
PlatformBdsPolicyBehavior (\r
  IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData,\r
  IN LIST_ENTRY                      *DriverOptionList,\r
  IN LIST_ENTRY                      *BootOptionList\r
  )\r
;\r
\r
VOID\r
PlatformBdsGetDriverOption (\r
  IN LIST_ENTRY               *BdsDriverLists\r
  )\r
;\r
\r
EFI_STATUS\r
BdsMemoryTest (\r
  EXTENDMEM_COVERAGE_LEVEL Level\r
  )\r
;\r
\r
EFI_STATUS\r
PlatformBdsShowProgress (\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,\r
  CHAR16                        *Title,\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,\r
  UINTN                         Progress,\r
  UINTN                         PreviousValue\r
  )\r
;\r
\r
VOID\r
PlatformBdsConnectSequence (\r
  VOID\r
  )\r
;\r
\r
VOID\r
PlatformBdsBootFail (\r
  IN  BDS_COMMON_OPTION  *Option,\r
  IN  EFI_STATUS         Status,\r
  IN  CHAR16             *ExitData,\r
  IN  UINTN              ExitDataSize\r
  )\r
;\r
\r
VOID\r
PlatformBdsBootSuccess (\r
  IN  BDS_COMMON_OPTION *Option\r
  )\r
;\r
\r
EFI_STATUS\r
ProcessCapsules (\r
  EFI_BOOT_MODE BootMode\r
  )\r
;\r
\r
EFI_STATUS\r
PlatformBdsConnectConsole (\r
  IN BDS_CONSOLE_CONNECT_ENTRY   *PlatformConsole\r
  )\r
;\r
\r
EFI_STATUS\r
PlatformBdsNoConsoleAction (\r
  VOID\r
  )\r
;\r
\r
#endif // _BDS_PLATFORM_H\r