[mirror_edk2.git] / IntelSiliconPkg / Feature / VTd / IntelVTdDxe / DmaProtection.h

/** @file\r
\r
  Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
  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
**/\r
\r
#ifndef _DMAR_PROTECTION_H_\r
#define _DMAR_PROTECTION_H_\r
\r
#include <Uefi.h>\r
#include <PiDxe.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/PciSegmentLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/CacheMaintenanceLib.h>\r
#include <Library/PerformanceLib.h>\r
#include <Library/PrintLib.h>\r
\r
#include <Guid/EventGroup.h>\r
#include <Guid/Acpi.h>\r
\r
#include <Protocol/DxeSmmReadyToLock.h>\r
#include <Protocol/PciRootBridgeIo.h>\r
#include <Protocol/PciIo.h>\r
#include <Protocol/PciEnumerationComplete.h>\r
#include <Protocol/PlatformVtdPolicy.h>\r
#include <Protocol/IoMmu.h>\r
\r
#include <IndustryStandard/Pci.h>\r
#include <IndustryStandard/DmaRemappingReportingTable.h>\r
#include <IndustryStandard/Vtd.h>\r
\r
#define VTD_64BITS_ADDRESS(Lo, Hi) (LShiftU64 (Lo, 12) | LShiftU64 (Hi, 32))\r
\r
#define ALIGN_VALUE_UP(Value, Alignment)  (((Value) + (Alignment) - 1) & (~((Alignment) - 1)))\r
#define ALIGN_VALUE_LOW(Value, Alignment) ((Value) & (~((Alignment) - 1)))\r
\r
//\r
// This is the initial max PCI DATA number.\r
// The number may be enlarged later.\r
//\r
#define MAX_VTD_PCI_DATA_NUMBER             0x100\r
\r
typedef struct {\r
  UINT8                            DeviceType;\r
  VTD_SOURCE_ID                    PciSourceId;\r
  EDKII_PLATFORM_VTD_PCI_DEVICE_ID PciDeviceId;\r
  // for statistic analysis\r
  UINTN                            AccessCount;\r
} PCI_DEVICE_DATA;\r
\r
typedef struct {\r
  BOOLEAN                          IncludeAllFlag;\r
  UINTN                            PciDeviceDataNumber;\r
  UINTN                            PciDeviceDataMaxNumber;\r
  PCI_DEVICE_DATA                  *PciDeviceData;\r
} PCI_DEVICE_INFORMATION;\r
\r
typedef struct {\r
  UINTN                            VtdUnitBaseAddress;\r
  UINT16                           Segment;\r
  VTD_CAP_REG                      CapReg;\r
  VTD_ECAP_REG                     ECapReg;\r
  VTD_ROOT_ENTRY                   *RootEntryTable;\r
  VTD_EXT_ROOT_ENTRY               *ExtRootEntryTable;\r
  VTD_SECOND_LEVEL_PAGING_ENTRY    *FixedSecondLevelPagingEntry;\r
  BOOLEAN                          HasDirtyContext;\r
  BOOLEAN                          HasDirtyPages;\r
  PCI_DEVICE_INFORMATION           PciDeviceInfo;\r
} VTD_UNIT_INFORMATION;\r
\r
/**\r
  The scan bus callback function.\r
\r
  It is called in PCI bus scan for each PCI device under the bus.\r
\r
  @param[in]  Context               The context of the callback.\r
  @param[in]  Segment               The segment of the source.\r
  @param[in]  Bus                   The bus of the source.\r
  @param[in]  Device                The device of the source.\r
  @param[in]  Function              The function of the source.\r
\r
  @retval EFI_SUCCESS           The specific PCI device is processed in the callback.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *SCAN_BUS_FUNC_CALLBACK_FUNC) (\r
  IN VOID           *Context,\r
  IN UINT16         Segment,\r
  IN UINT8          Bus,\r
  IN UINT8          Device,\r
  IN UINT8          Function\r
  );\r
\r
extern EFI_ACPI_DMAR_HEADER  *mAcpiDmarTable;\r
\r
extern UINT64                           mVtdHostAddressWidthMask;\r
extern UINTN                            mVtdUnitNumber;\r
extern VTD_UNIT_INFORMATION             *mVtdUnitInformation;\r
\r
extern UINT64                           mBelow4GMemoryLimit;\r
extern UINT64                           mAbove4GMemoryLimit;\r
\r
extern EDKII_PLATFORM_VTD_POLICY_PROTOCOL   *mPlatformVTdPolicy;\r
\r
/**\r
  Prepare VTD configuration.\r
**/\r
VOID\r
PrepareVtdConfig (\r
  VOID\r
  );\r
\r
/**\r
  Setup VTd translation table.\r
\r
  @retval EFI_SUCCESS           Setup translation table successfully.\r
  @retval EFI_OUT_OF_RESOURCE   Setup translation table fail.\r
**/\r
EFI_STATUS\r
SetupTranslationTable (\r
  VOID\r
  );\r
\r
/**\r
  Enable DMAR translation.\r
\r
  @retval EFI_SUCCESS           DMAR translation is enabled.\r
  @retval EFI_DEVICE_ERROR      DMAR translation is not enabled.\r
**/\r
EFI_STATUS\r
EnableDmar (\r
  VOID\r
  );\r
\r
/**\r
  Disable DMAR translation.\r
\r
  @retval EFI_SUCCESS           DMAR translation is disabled.\r
  @retval EFI_DEVICE_ERROR      DMAR translation is not disabled.\r
**/\r
EFI_STATUS\r
DisableDmar (\r
  VOID\r
  );\r
\r
/**\r
  Invalid VTd global IOTLB.\r
\r
  @param[in]  VtdIndex              The index of VTd engine.\r
\r
  @retval EFI_SUCCESS           VTd global IOTLB is invalidated.\r
  @retval EFI_DEVICE_ERROR      VTd global IOTLB is not invalidated.\r
**/\r
EFI_STATUS\r
InvalidateVtdIOTLBGlobal (\r
  IN UINTN  VtdIndex\r
  );\r
\r
/**\r
  Dump VTd registers.\r
\r
  @param[in]  VtdIndex              The index of VTd engine.\r
**/\r
VOID\r
DumpVtdRegs (\r
  IN UINTN  VtdIndex\r
  );\r
\r
/**\r
  Dump VTd registers for all VTd engine.\r
**/\r
VOID\r
DumpVtdRegsAll (\r
  VOID\r
  );\r
\r
/**\r
  Dump VTd capability registers.\r
\r
  @param[in]  CapReg              The capability register.\r
**/\r
VOID\r
DumpVtdCapRegs (\r
  IN VTD_CAP_REG *CapReg\r
  );\r
\r
/**\r
  Dump VTd extended capability registers.\r
\r
  @param[in]  ECapReg              The extended capability register.\r
**/\r
VOID\r
DumpVtdECapRegs (\r
  IN VTD_ECAP_REG *ECapReg\r
  );\r
\r
/**\r
  Register PCI device to VTd engine.\r
\r
  @param[in]  VtdIndex              The index of VTd engine.\r
  @param[in]  Segment               The segment of the source.\r
  @param[in]  SourceId              The SourceId of the source.\r
  @param[in]  DeviceType            The DMAR device scope type.\r
  @param[in]  CheckExist            TRUE: ERROR will be returned if the PCI device is already registered.\r
                                    FALSE: SUCCESS will be returned if the PCI device is registered.\r
\r
  @retval EFI_SUCCESS           The PCI device is registered.\r
  @retval EFI_OUT_OF_RESOURCES  No enough resource to register a new PCI device.\r
  @retval EFI_ALREADY_STARTED   The device is already registered.\r
**/\r
EFI_STATUS\r
RegisterPciDevice (\r
  IN UINTN          VtdIndex,\r
  IN UINT16         Segment,\r
  IN VTD_SOURCE_ID  SourceId,\r
  IN UINT8          DeviceType,\r
  IN BOOLEAN        CheckExist\r
  );\r
\r
/**\r
  The scan bus callback function to always enable page attribute.\r
\r
  @param[in]  Context               The context of the callback.\r
  @param[in]  Segment               The segment of the source.\r
  @param[in]  Bus                   The bus of the source.\r
  @param[in]  Device                The device of the source.\r
  @param[in]  Function              The function of the source.\r
\r
  @retval EFI_SUCCESS           The VTd entry is updated to always enable all DMA access for the specific device.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ScanBusCallbackRegisterPciDevice (\r
  IN VOID           *Context,\r
  IN UINT16         Segment,\r
  IN UINT8          Bus,\r
  IN UINT8          Device,\r
  IN UINT8          Function\r
  );\r
\r
/**\r
  Scan PCI bus and invoke callback function for each PCI devices under the bus.\r
\r
  @param[in]  Context               The context of the callback function.\r
  @param[in]  Segment               The segment of the source.\r
  @param[in]  Bus                   The bus of the source.\r
  @param[in]  Callback              The callback function in PCI scan.\r
\r
  @retval EFI_SUCCESS           The PCI devices under the bus are scaned.\r
**/\r
EFI_STATUS\r
ScanPciBus (\r
  IN VOID                         *Context,\r
  IN UINT16                       Segment,\r
  IN UINT8                        Bus,\r
  IN SCAN_BUS_FUNC_CALLBACK_FUNC  Callback\r
  );\r
\r
/**\r
  Dump the PCI device information managed by this VTd engine.\r
\r
  @param[in]  VtdIndex              The index of VTd engine.\r
**/\r
VOID\r
DumpPciDeviceInfo (\r
  IN UINTN  VtdIndex\r
  );\r
\r
/**\r
  Find the VTd index by the Segment and SourceId.\r
\r
  @param[in]  Segment               The segment of the source.\r
  @param[in]  SourceId              The SourceId of the source.\r
  @param[out] ExtContextEntry       The ExtContextEntry of the source.\r
  @param[out] ContextEntry          The ContextEntry of the source.\r
\r
  @return The index of the VTd engine.\r
  @retval (UINTN)-1  The VTd engine is not found.\r
**/\r
UINTN\r
FindVtdIndexByPciDevice (\r
  IN  UINT16                  Segment,\r
  IN  VTD_SOURCE_ID           SourceId,\r
  OUT VTD_EXT_CONTEXT_ENTRY   **ExtContextEntry,\r
  OUT VTD_CONTEXT_ENTRY       **ContextEntry\r
  );\r
\r
/**\r
  Get the DMAR ACPI table.\r
\r
  @retval EFI_SUCCESS    The DMAR ACPI table is got.\r
  @retval EFI_NOT_FOUND  The DMAR ACPI table is not found.\r
**/\r
EFI_STATUS\r
GetDmarAcpiTable (\r
  VOID\r
  );\r
\r
/**\r
  Parse DMAR DRHD table.\r
\r
  @return EFI_SUCCESS  The DMAR DRHD table is parsed.\r
**/\r
EFI_STATUS\r
ParseDmarAcpiTableDrhd (\r
  VOID\r
  );\r
\r
/**\r
  Parse DMAR RMRR table.\r
\r
  @return EFI_SUCCESS  The DMAR RMRR table is parsed.\r
**/\r
EFI_STATUS\r
ParseDmarAcpiTableRmrr (\r
  VOID\r
  );\r
\r
/**\r
  Dump DMAR context entry table.\r
\r
  @param[in]  RootEntry DMAR root entry.\r
**/\r
VOID\r
DumpDmarContextEntryTable (\r
  IN VTD_ROOT_ENTRY *RootEntry\r
  );\r
\r
/**\r
  Dump DMAR extended context entry table.\r
\r
  @param[in]  ExtRootEntry DMAR extended root entry.\r
**/\r
VOID\r
DumpDmarExtContextEntryTable (\r
  IN VTD_EXT_ROOT_ENTRY *ExtRootEntry\r
  );\r
\r
/**\r
  Dump DMAR second level paging entry.\r
\r
  @param[in]  SecondLevelPagingEntry The second level paging entry.\r
**/\r
VOID\r
DumpSecondLevelPagingEntry (\r
  IN VOID *SecondLevelPagingEntry\r
  );\r
\r
/**\r
  Set VTd attribute for a system memory.\r
\r
  @param[in]  VtdIndex                The index used to identify a VTd engine.\r
  @param[in]  DomainIdentifier        The domain ID of the source.\r
  @param[in]  SecondLevelPagingEntry  The second level paging entry in VTd table for the device.\r
  @param[in]  BaseAddress             The base of device memory address to be used as the DMA memory.\r
  @param[in]  Length                  The length of device memory address to be used as the DMA memory.\r
  @param[in]  IoMmuAccess             The IOMMU access.\r
\r
  @retval EFI_SUCCESS            The IoMmuAccess is set for the memory range specified by BaseAddress and Length.\r
  @retval EFI_INVALID_PARAMETER  BaseAddress is not IoMmu Page size aligned.\r
  @retval EFI_INVALID_PARAMETER  Length is not IoMmu Page size aligned.\r
  @retval EFI_INVALID_PARAMETER  Length is 0.\r
  @retval EFI_INVALID_PARAMETER  IoMmuAccess specified an illegal combination of access.\r
  @retval EFI_UNSUPPORTED        The bit mask of IoMmuAccess is not supported by the IOMMU.\r
  @retval EFI_UNSUPPORTED        The IOMMU does not support the memory range specified by BaseAddress and Length.\r
  @retval EFI_OUT_OF_RESOURCES   There are not enough resources available to modify the IOMMU access.\r
  @retval EFI_DEVICE_ERROR       The IOMMU device reported an error while attempting the operation.\r
**/\r
EFI_STATUS\r
SetPageAttribute (\r
  IN UINTN                         VtdIndex,\r
  IN UINT16                        DomainIdentifier,\r
  IN VTD_SECOND_LEVEL_PAGING_ENTRY *SecondLevelPagingEntry,\r
  IN UINT64                        BaseAddress,\r
  IN UINT64                        Length,\r
  IN UINT64                        IoMmuAccess\r
  );\r
\r
/**\r
  Set VTd attribute for a system memory.\r
\r
  @param[in]  Segment           The Segment used to identify a VTd engine.\r
  @param[in]  SourceId          The SourceId used to identify a VTd engine and table entry.\r
  @param[in]  BaseAddress       The base of device memory address to be used as the DMA memory.\r
  @param[in]  Length            The length of device memory address to be used as the DMA memory.\r
  @param[in]  IoMmuAccess       The IOMMU access.\r
\r
  @retval EFI_SUCCESS            The IoMmuAccess is set for the memory range specified by BaseAddress and Length.\r
  @retval EFI_INVALID_PARAMETER  BaseAddress is not IoMmu Page size aligned.\r
  @retval EFI_INVALID_PARAMETER  Length is not IoMmu Page size aligned.\r
  @retval EFI_INVALID_PARAMETER  Length is 0.\r
  @retval EFI_INVALID_PARAMETER  IoMmuAccess specified an illegal combination of access.\r
  @retval EFI_UNSUPPORTED        The bit mask of IoMmuAccess is not supported by the IOMMU.\r
  @retval EFI_UNSUPPORTED        The IOMMU does not support the memory range specified by BaseAddress and Length.\r
  @retval EFI_OUT_OF_RESOURCES   There are not enough resources available to modify the IOMMU access.\r
  @retval EFI_DEVICE_ERROR       The IOMMU device reported an error while attempting the operation.\r
**/\r
EFI_STATUS\r
SetAccessAttribute (\r
  IN UINT16                Segment,\r
  IN VTD_SOURCE_ID         SourceId,\r
  IN UINT64                BaseAddress,\r
  IN UINT64                Length,\r
  IN UINT64                IoMmuAccess\r
  );\r
\r
/**\r
  Return the index of PCI data.\r
\r
  @param[in]  VtdIndex          The index used to identify a VTd engine.\r
  @param[in]  Segment           The Segment used to identify a VTd engine.\r
  @param[in]  SourceId          The SourceId used to identify a VTd engine and table entry.\r
\r
  @return The index of the PCI data.\r
  @retval (UINTN)-1  The PCI data is not found.\r
**/\r
UINTN\r
GetPciDataIndex (\r
  IN UINTN          VtdIndex,\r
  IN UINT16         Segment,\r
  IN VTD_SOURCE_ID  SourceId\r
  );\r
\r
/**\r
  Dump VTd registers if there is error.\r
**/\r
VOID\r
DumpVtdIfError (\r
  VOID\r
  );\r
\r
/**\r
  Initialize platform VTd policy.\r
**/\r
VOID\r
InitializePlatformVTdPolicy (\r
  VOID\r
  );\r
\r
/**\r
  Always enable the VTd page attribute for the device.\r
\r
  @param[in]  Segment           The Segment used to identify a VTd engine.\r
  @param[in]  SourceId          The SourceId used to identify a VTd engine and table entry.\r
\r
  @retval EFI_SUCCESS           The VTd entry is updated to always enable all DMA access for the specific device.\r
**/\r
EFI_STATUS\r
AlwaysEnablePageAttribute (\r
  IN UINT16                  Segment,\r
  IN VTD_SOURCE_ID           SourceId\r
  );\r
\r
/**\r
  Convert the DeviceHandle to SourceId and Segment.\r
\r
  @param[in]  DeviceHandle      The device who initiates the DMA access request.\r
  @param[out] Segment           The Segment used to identify a VTd engine.\r
  @param[out] SourceId          The SourceId used to identify a VTd engine and table entry.\r
\r
  @retval EFI_SUCCESS            The Segment and SourceId are returned.\r
  @retval EFI_INVALID_PARAMETER  DeviceHandle is an invalid handle.\r
  @retval EFI_UNSUPPORTED        DeviceHandle is unknown by the IOMMU.\r
**/\r
EFI_STATUS\r
DeviceHandleToSourceId (\r
  IN EFI_HANDLE            DeviceHandle,\r
  OUT UINT16               *Segment,\r
  OUT VTD_SOURCE_ID        *SourceId\r
  );\r
\r
/**\r
  Get device information from mapping.\r
\r
  @param[in]  Mapping        The mapping.\r
  @param[out] DeviceAddress  The device address of the mapping.\r
  @param[out] NumberOfPages  The number of pages of the mapping.\r
\r
  @retval EFI_SUCCESS            The device information is returned.\r
  @retval EFI_INVALID_PARAMETER  The mapping is invalid.\r
**/\r
EFI_STATUS\r
GetDeviceInfoFromMapping (\r
  IN  VOID                                     *Mapping,\r
  OUT EFI_PHYSICAL_ADDRESS                     *DeviceAddress,\r
  OUT UINTN                                    *NumberOfPages\r
  );\r
\r
/**\r
  Initialize DMA protection.\r
**/\r
VOID\r
InitializeDmaProtection (\r
  VOID\r
  );\r
\r
/**\r
  Allocate zero pages.\r
\r
  @param[in]  Pages the number of pages.\r
\r
  @return the page address.\r
  @retval NULL No resource to allocate pages.\r
**/\r
VOID *\r
EFIAPI\r
AllocateZeroPages (\r
  IN UINTN  Pages\r
  );\r
\r
/**\r
  Flush VTD page table and context table memory.\r
\r
  This action is to make sure the IOMMU engine can get final data in memory.\r
\r
  @param[in]  VtdIndex          The index used to identify a VTd engine.\r
  @param[in]  Base              The base address of memory to be flushed.\r
  @param[in]  Size              The size of memory in bytes to be flushed.\r
**/\r
VOID\r
FlushPageTableMemory (\r
  IN UINTN  VtdIndex,\r
  IN UINTN  Base,\r
  IN UINTN  Size\r
  );\r
\r
/**\r
  Get PCI device information from DMAR DevScopeEntry.\r
\r
  @param[in]  Segment               The segment number.\r
  @param[in]  DmarDevScopeEntry     DMAR DevScopeEntry\r
  @param[out] Bus                   The bus number.\r
  @param[out] Device                The device number.\r
  @param[out] Function              The function number.\r
\r
  @retval EFI_SUCCESS  The PCI device information is returned.\r
**/\r
EFI_STATUS\r
GetPciBusDeviceFunction (\r
  IN  UINT16                                      Segment,\r
  IN  EFI_ACPI_DMAR_DEVICE_SCOPE_STRUCTURE_HEADER *DmarDevScopeEntry,\r
  OUT UINT8                                       *Bus,\r
  OUT UINT8                                       *Device,\r
  OUT UINT8                                       *Function\r
  );\r
\r
#endif\r
Commit	Line	Data
c049fc99 JY	1	/** @file\r
	2	\r
	3	Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
	4	This program and the accompanying materials\r
	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php.\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	**/\r
	13	\r
	14	#ifndef _DMAR_PROTECTION_H_\r
	15	#define _DMAR_PROTECTION_H_\r
	16	\r
	17	#include <Uefi.h>\r
	18	#include <PiDxe.h>\r
	19	\r
	20	#include <Library/BaseLib.h>\r
	21	#include <Library/BaseMemoryLib.h>\r
	22	#include <Library/MemoryAllocationLib.h>\r
	23	#include <Library/UefiBootServicesTableLib.h>\r
	24	#include <Library/IoLib.h>\r
	25	#include <Library/PciSegmentLib.h>\r
	26	#include <Library/DebugLib.h>\r
	27	#include <Library/UefiLib.h>\r
4ad5f597 JY	28	#include <Library/CacheMaintenanceLib.h>\r
	29	#include <Library/PerformanceLib.h>\r
	30	#include <Library/PrintLib.h>\r
c049fc99 JY	31	\r
	32	#include <Guid/EventGroup.h>\r
	33	#include <Guid/Acpi.h>\r
	34	\r
	35	#include <Protocol/DxeSmmReadyToLock.h>\r
	36	#include <Protocol/PciRootBridgeIo.h>\r
	37	#include <Protocol/PciIo.h>\r
	38	#include <Protocol/PciEnumerationComplete.h>\r
c049fc99 JY	39	#include <Protocol/PlatformVtdPolicy.h>\r
	40	#include <Protocol/IoMmu.h>\r
	41	\r
	42	#include <IndustryStandard/Pci.h>\r
	43	#include <IndustryStandard/DmaRemappingReportingTable.h>\r
	44	#include <IndustryStandard/Vtd.h>\r
	45	\r
76c6f69c SZ	46	#define VTD_64BITS_ADDRESS(Lo, Hi) (LShiftU64 (Lo, 12) \| LShiftU64 (Hi, 32))\r
76c6f69c SZ	47	\r
c049fc99 JY	48	#define ALIGN_VALUE_UP(Value, Alignment) (((Value) + (Alignment) - 1) & (~((Alignment) - 1)))\r
	49	#define ALIGN_VALUE_LOW(Value, Alignment) ((Value) & (~((Alignment) - 1)))\r
	50	\r
	51	//\r
f77d35c7	52	// This is the initial max PCI DATA number.\r
c049fc99 JY	53	// The number may be enlarged later.\r
c049fc99 JY	54	//\r
f77d35c7	55	#define MAX_VTD_PCI_DATA_NUMBER 0x100\r
c049fc99 JY	56	\r
c049fc99 JY	57	typedef struct {\r
f77d35c7 JY	58	UINT8 DeviceType;\r
	59	VTD_SOURCE_ID PciSourceId;\r
	60	EDKII_PLATFORM_VTD_PCI_DEVICE_ID PciDeviceId;\r
4ad5f597	61	// for statistic analysis\r
f77d35c7 JY	62	UINTN AccessCount;\r
	63	} PCI_DEVICE_DATA;\r
	64	\r
	65	typedef struct {\r
	66	BOOLEAN IncludeAllFlag;\r
	67	UINTN PciDeviceDataNumber;\r
	68	UINTN PciDeviceDataMaxNumber;\r
	69	PCI_DEVICE_DATA *PciDeviceData;\r
c049fc99 JY	70	} PCI_DEVICE_INFORMATION;\r
	71	\r
	72	typedef struct {\r
	73	UINTN VtdUnitBaseAddress;\r
	74	UINT16 Segment;\r
	75	VTD_CAP_REG CapReg;\r
	76	VTD_ECAP_REG ECapReg;\r
	77	VTD_ROOT_ENTRY *RootEntryTable;\r
	78	VTD_EXT_ROOT_ENTRY *ExtRootEntryTable;\r
	79	VTD_SECOND_LEVEL_PAGING_ENTRY *FixedSecondLevelPagingEntry;\r
4ad5f597	80	BOOLEAN HasDirtyContext;\r
c049fc99 JY	81	BOOLEAN HasDirtyPages;\r
	82	PCI_DEVICE_INFORMATION PciDeviceInfo;\r
	83	} VTD_UNIT_INFORMATION;\r
	84	\r
f77d35c7 JY	85	/**\r
	86	The scan bus callback function.\r
	87	\r
	88	It is called in PCI bus scan for each PCI device under the bus.\r
	89	\r
	90	@param[in] Context The context of the callback.\r
	91	@param[in] Segment The segment of the source.\r
	92	@param[in] Bus The bus of the source.\r
	93	@param[in] Device The device of the source.\r
	94	@param[in] Function The function of the source.\r
	95	\r
	96	@retval EFI_SUCCESS The specific PCI device is processed in the callback.\r
	97	**/\r
	98	typedef\r
	99	EFI_STATUS\r
	100	(EFIAPI *SCAN_BUS_FUNC_CALLBACK_FUNC) (\r
	101	IN VOID *Context,\r
	102	IN UINT16 Segment,\r
	103	IN UINT8 Bus,\r
	104	IN UINT8 Device,\r
	105	IN UINT8 Function\r
	106	);\r
	107	\r
c049fc99 JY	108	extern EFI_ACPI_DMAR_HEADER *mAcpiDmarTable;\r
	109	\r
	110	extern UINT64 mVtdHostAddressWidthMask;\r
	111	extern UINTN mVtdUnitNumber;\r
	112	extern VTD_UNIT_INFORMATION *mVtdUnitInformation;\r
	113	\r
	114	extern UINT64 mBelow4GMemoryLimit;\r
	115	extern UINT64 mAbove4GMemoryLimit;\r
	116	\r
	117	extern EDKII_PLATFORM_VTD_POLICY_PROTOCOL *mPlatformVTdPolicy;\r
	118	\r
	119	/**\r
	120	Prepare VTD configuration.\r
	121	**/\r
	122	VOID\r
	123	PrepareVtdConfig (\r
	124	VOID\r
	125	);\r
	126	\r
	127	/**\r
	128	Setup VTd translation table.\r
	129	\r
	130	@retval EFI_SUCCESS Setup translation table successfully.\r
	131	@retval EFI_OUT_OF_RESOURCE Setup translation table fail.\r
	132	**/\r
	133	EFI_STATUS\r
	134	SetupTranslationTable (\r
	135	VOID\r
	136	);\r
	137	\r
	138	/**\r
	139	Enable DMAR translation.\r
	140	\r
	141	@retval EFI_SUCCESS DMAR translation is enabled.\r
	142	@retval EFI_DEVICE_ERROR DMAR translation is not enabled.\r
	143	**/\r
	144	EFI_STATUS\r
	145	EnableDmar (\r
	146	VOID\r
	147	);\r
	148	\r
	149	/**\r
	150	Disable DMAR translation.\r
	151	\r
	152	@retval EFI_SUCCESS DMAR translation is disabled.\r
	153	@retval EFI_DEVICE_ERROR DMAR translation is not disabled.\r
	154	**/\r
	155	EFI_STATUS\r
	156	DisableDmar (\r
	157	VOID\r
	158	);\r
	159	\r
c049fc99 JY	160	/**\r
	161	Invalid VTd global IOTLB.\r
	162	\r
	163	@param[in] VtdIndex The index of VTd engine.\r
	164	\r
	165	@retval EFI_SUCCESS VTd global IOTLB is invalidated.\r
	166	@retval EFI_DEVICE_ERROR VTd global IOTLB is not invalidated.\r
	167	**/\r
	168	EFI_STATUS\r
	169	InvalidateVtdIOTLBGlobal (\r
	170	IN UINTN VtdIndex\r
	171	);\r
	172	\r
	173	/**\r
	174	Dump VTd registers.\r
	175	\r
	176	@param[in] VtdIndex The index of VTd engine.\r
	177	**/\r
	178	VOID\r
	179	DumpVtdRegs (\r
	180	IN UINTN VtdIndex\r
	181	);\r
	182	\r
	183	/**\r
	184	Dump VTd registers for all VTd engine.\r
	185	**/\r
	186	VOID\r
	187	DumpVtdRegsAll (\r
	188	VOID\r
	189	);\r
	190	\r
	191	/**\r
	192	Dump VTd capability registers.\r
	193	\r
	194	@param[in] CapReg The capability register.\r
	195	**/\r
	196	VOID\r
	197	DumpVtdCapRegs (\r
	198	IN VTD_CAP_REG *CapReg\r
	199	);\r
	200	\r
	201	/**\r
	202	Dump VTd extended capability registers.\r
	203	\r
	204	@param[in] ECapReg The extended capability register.\r
	205	**/\r
	206	VOID\r
	207	DumpVtdECapRegs (\r
	208	IN VTD_ECAP_REG *ECapReg\r
	209	);\r
	210	\r
	211	/**\r
f77d35c7	212	Register PCI device to VTd engine.\r
c049fc99 JY	213	\r
	214	@param[in] VtdIndex The index of VTd engine.\r
	215	@param[in] Segment The segment of the source.\r
	216	@param[in] SourceId The SourceId of the source.\r
f77d35c7	217	@param[in] DeviceType The DMAR device scope type.\r
c049fc99 JY	218	@param[in] CheckExist TRUE: ERROR will be returned if the PCI device is already registered.\r
	219	FALSE: SUCCESS will be returned if the PCI device is registered.\r
	220	\r
	221	@retval EFI_SUCCESS The PCI device is registered.\r
	222	@retval EFI_OUT_OF_RESOURCES No enough resource to register a new PCI device.\r
	223	@retval EFI_ALREADY_STARTED The device is already registered.\r
	224	**/\r
	225	EFI_STATUS\r
	226	RegisterPciDevice (\r
	227	IN UINTN VtdIndex,\r
	228	IN UINT16 Segment,\r
	229	IN VTD_SOURCE_ID SourceId,\r
f77d35c7	230	IN UINT8 DeviceType,\r
c049fc99 JY	231	IN BOOLEAN CheckExist\r
	232	);\r
	233	\r
	234	/**\r
f77d35c7	235	The scan bus callback function to always enable page attribute.\r
c049fc99	236	\r
f77d35c7	237	@param[in] Context The context of the callback.\r
c049fc99 JY	238	@param[in] Segment The segment of the source.\r
c049fc99 JY	239	@param[in] Bus The bus of the source.\r
f77d35c7 JY	240	@param[in] Device The device of the source.\r
f77d35c7 JY	241	@param[in] Function The function of the source.\r
c049fc99	242	\r
f77d35c7	243	@retval EFI_SUCCESS The VTd entry is updated to always enable all DMA access for the specific device.\r
c049fc99 JY	244	**/\r
c049fc99 JY	245	EFI_STATUS\r
f77d35c7 JY	246	EFIAPI\r
	247	ScanBusCallbackRegisterPciDevice (\r
	248	IN VOID *Context,\r
c049fc99	249	IN UINT16 Segment,\r
f77d35c7 JY	250	IN UINT8 Bus,\r
	251	IN UINT8 Device,\r
	252	IN UINT8 Function\r
	253	);\r
	254	\r
	255	/**\r
	256	Scan PCI bus and invoke callback function for each PCI devices under the bus.\r
	257	\r
	258	@param[in] Context The context of the callback function.\r
	259	@param[in] Segment The segment of the source.\r
	260	@param[in] Bus The bus of the source.\r
	261	@param[in] Callback The callback function in PCI scan.\r
	262	\r
	263	@retval EFI_SUCCESS The PCI devices under the bus are scaned.\r
	264	**/\r
	265	EFI_STATUS\r
	266	ScanPciBus (\r
	267	IN VOID *Context,\r
	268	IN UINT16 Segment,\r
	269	IN UINT8 Bus,\r
	270	IN SCAN_BUS_FUNC_CALLBACK_FUNC Callback\r
c049fc99 JY	271	);\r
	272	\r
	273	/**\r
	274	Dump the PCI device information managed by this VTd engine.\r
	275	\r
	276	@param[in] VtdIndex The index of VTd engine.\r
	277	**/\r
	278	VOID\r
	279	DumpPciDeviceInfo (\r
	280	IN UINTN VtdIndex\r
	281	);\r
	282	\r
	283	/**\r
	284	Find the VTd index by the Segment and SourceId.\r
	285	\r
	286	@param[in] Segment The segment of the source.\r
	287	@param[in] SourceId The SourceId of the source.\r
	288	@param[out] ExtContextEntry The ExtContextEntry of the source.\r
	289	@param[out] ContextEntry The ContextEntry of the source.\r
	290	\r
f77d35c7 JY	291	@return The index of the VTd engine.\r
f77d35c7 JY	292	@retval (UINTN)-1 The VTd engine is not found.\r
c049fc99 JY	293	**/\r
	294	UINTN\r
	295	FindVtdIndexByPciDevice (\r
	296	IN UINT16 Segment,\r
	297	IN VTD_SOURCE_ID SourceId,\r
	298	OUT VTD_EXT_CONTEXT_ENTRY **ExtContextEntry,\r
	299	OUT VTD_CONTEXT_ENTRY **ContextEntry\r
	300	);\r
	301	\r
	302	/**\r
	303	Get the DMAR ACPI table.\r
	304	\r
	305	@retval EFI_SUCCESS The DMAR ACPI table is got.\r
	306	@retval EFI_NOT_FOUND The DMAR ACPI table is not found.\r
	307	**/\r
	308	EFI_STATUS\r
	309	GetDmarAcpiTable (\r
	310	VOID\r
	311	);\r
	312	\r
	313	/**\r
	314	Parse DMAR DRHD table.\r
	315	\r
	316	@return EFI_SUCCESS The DMAR DRHD table is parsed.\r
	317	**/\r
	318	EFI_STATUS\r
	319	ParseDmarAcpiTableDrhd (\r
	320	VOID\r
	321	);\r
	322	\r
	323	/**\r
	324	Parse DMAR RMRR table.\r
	325	\r
	326	@return EFI_SUCCESS The DMAR RMRR table is parsed.\r
	327	**/\r
	328	EFI_STATUS\r
	329	ParseDmarAcpiTableRmrr (\r
	330	VOID\r
	331	);\r
	332	\r
	333	/**\r
	334	Dump DMAR context entry table.\r
	335	\r
	336	@param[in] RootEntry DMAR root entry.\r
	337	**/\r
	338	VOID\r
	339	DumpDmarContextEntryTable (\r
	340	IN VTD_ROOT_ENTRY *RootEntry\r
	341	);\r
	342	\r
	343	/**\r
	344	Dump DMAR extended context entry table.\r
	345	\r
	346	@param[in] ExtRootEntry DMAR extended root entry.\r
	347	**/\r
	348	VOID\r
	349	DumpDmarExtContextEntryTable (\r
	350	IN VTD_EXT_ROOT_ENTRY *ExtRootEntry\r
	351	);\r
	352	\r
	353	/**\r
	354	Dump DMAR second level paging entry.\r
	355	\r
	356	@param[in] SecondLevelPagingEntry The second level paging entry.\r
357	**/\r
358	VOID\r
359	DumpSecondLevelPagingEntry (\r
360	IN VOID *SecondLevelPagingEntry\r
361	);\r
362	\r
363	/**\r
364	Set VTd attribute for a system memory.\r
365	\r
366	@param[in] VtdIndex The index used to identify a VTd engine.\r
d654bf85	367	@param[in] DomainIdentifier The domain ID of the source.\r
c049fc99 JY	368	@param[in] SecondLevelPagingEntry The second level paging entry in VTd table for the device.\r
	369	@param[in] BaseAddress The base of device memory address to be used as the DMA memory.\r
	370	@param[in] Length The length of device memory address to be used as the DMA memory.\r
	371	@param[in] IoMmuAccess The IOMMU access.\r
	372	\r
	373	@retval EFI_SUCCESS The IoMmuAccess is set for the memory range specified by BaseAddress and Length.\r
	374	@retval EFI_INVALID_PARAMETER BaseAddress is not IoMmu Page size aligned.\r
	375	@retval EFI_INVALID_PARAMETER Length is not IoMmu Page size aligned.\r
	376	@retval EFI_INVALID_PARAMETER Length is 0.\r
	377	@retval EFI_INVALID_PARAMETER IoMmuAccess specified an illegal combination of access.\r
	378	@retval EFI_UNSUPPORTED The bit mask of IoMmuAccess is not supported by the IOMMU.\r
	379	@retval EFI_UNSUPPORTED The IOMMU does not support the memory range specified by BaseAddress and Length.\r
	380	@retval EFI_OUT_OF_RESOURCES There are not enough resources available to modify the IOMMU access.\r
	381	@retval EFI_DEVICE_ERROR The IOMMU device reported an error while attempting the operation.\r
	382	**/\r
	383	EFI_STATUS\r
	384	SetPageAttribute (\r
	385	IN UINTN VtdIndex,\r
4ad5f597	386	IN UINT16 DomainIdentifier,\r
c049fc99 JY	387	IN VTD_SECOND_LEVEL_PAGING_ENTRY *SecondLevelPagingEntry,\r
	388	IN UINT64 BaseAddress,\r
	389	IN UINT64 Length,\r
	390	IN UINT64 IoMmuAccess\r
	391	);\r
	392	\r
	393	/**\r
	394	Set VTd attribute for a system memory.\r
	395	\r
	396	@param[in] Segment The Segment used to identify a VTd engine.\r
	397	@param[in] SourceId The SourceId used to identify a VTd engine and table entry.\r
	398	@param[in] BaseAddress The base of device memory address to be used as the DMA memory.\r
	399	@param[in] Length The length of device memory address to be used as the DMA memory.\r
	400	@param[in] IoMmuAccess The IOMMU access.\r
	401	\r
	402	@retval EFI_SUCCESS The IoMmuAccess is set for the memory range specified by BaseAddress and Length.\r
	403	@retval EFI_INVALID_PARAMETER BaseAddress is not IoMmu Page size aligned.\r
	404	@retval EFI_INVALID_PARAMETER Length is not IoMmu Page size aligned.\r
	405	@retval EFI_INVALID_PARAMETER Length is 0.\r
	406	@retval EFI_INVALID_PARAMETER IoMmuAccess specified an illegal combination of access.\r
	407	@retval EFI_UNSUPPORTED The bit mask of IoMmuAccess is not supported by the IOMMU.\r
	408	@retval EFI_UNSUPPORTED The IOMMU does not support the memory range specified by BaseAddress and Length.\r
	409	@retval EFI_OUT_OF_RESOURCES There are not enough resources available to modify the IOMMU access.\r
	410	@retval EFI_DEVICE_ERROR The IOMMU device reported an error while attempting the operation.\r
	411	**/\r
	412	EFI_STATUS\r
	413	SetAccessAttribute (\r
	414	IN UINT16 Segment,\r
	415	IN VTD_SOURCE_ID SourceId,\r
	416	IN UINT64 BaseAddress,\r
	417	IN UINT64 Length,\r
	418	IN UINT64 IoMmuAccess\r
	419	);\r
	420	\r
	421	/**\r
f77d35c7	422	Return the index of PCI data.\r
c049fc99 JY	423	\r
	424	@param[in] VtdIndex The index used to identify a VTd engine.\r
	425	@param[in] Segment The Segment used to identify a VTd engine.\r
	426	@param[in] SourceId The SourceId used to identify a VTd engine and table entry.\r
	427	\r
f77d35c7 JY	428	@return The index of the PCI data.\r
f77d35c7 JY	429	@retval (UINTN)-1 The PCI data is not found.\r
c049fc99 JY	430	**/\r
c049fc99 JY	431	UINTN\r
f77d35c7	432	GetPciDataIndex (\r
c049fc99 JY	433	IN UINTN VtdIndex,\r
	434	IN UINT16 Segment,\r
	435	IN VTD_SOURCE_ID SourceId\r
	436	);\r
	437	\r
	438	/**\r
	439	Dump VTd registers if there is error.\r
	440	**/\r
	441	VOID\r
	442	DumpVtdIfError (\r
	443	VOID\r
	444	);\r
	445	\r
	446	/**\r
	447	Initialize platform VTd policy.\r
	448	**/\r
	449	VOID\r
	450	InitializePlatformVTdPolicy (\r
	451	VOID\r
	452	);\r
	453	\r
	454	/**\r
	455	Always enable the VTd page attribute for the device.\r
	456	\r
	457	@param[in] Segment The Segment used to identify a VTd engine.\r
	458	@param[in] SourceId The SourceId used to identify a VTd engine and table entry.\r
	459	\r
	460	@retval EFI_SUCCESS The VTd entry is updated to always enable all DMA access for the specific device.\r
	461	**/\r
	462	EFI_STATUS\r
	463	AlwaysEnablePageAttribute (\r
	464	IN UINT16 Segment,\r
	465	IN VTD_SOURCE_ID SourceId\r
	466	);\r
	467	\r
	468	/**\r
	469	Convert the DeviceHandle to SourceId and Segment.\r
	470	\r
	471	@param[in] DeviceHandle The device who initiates the DMA access request.\r
	472	@param[out] Segment The Segment used to identify a VTd engine.\r
	473	@param[out] SourceId The SourceId used to identify a VTd engine and table entry.\r
	474	\r
	475	@retval EFI_SUCCESS The Segment and SourceId are returned.\r
	476	@retval EFI_INVALID_PARAMETER DeviceHandle is an invalid handle.\r
	477	@retval EFI_UNSUPPORTED DeviceHandle is unknown by the IOMMU.\r
	478	**/\r
	479	EFI_STATUS\r
	480	DeviceHandleToSourceId (\r
	481	IN EFI_HANDLE DeviceHandle,\r
	482	OUT UINT16 *Segment,\r
	483	OUT VTD_SOURCE_ID *SourceId\r
	484	);\r
	485	\r
	486	/**\r
	487	Get device information from mapping.\r
	488	\r
	489	@param[in] Mapping The mapping.\r
	490	@param[out] DeviceAddress The device address of the mapping.\r
	491	@param[out] NumberOfPages The number of pages of the mapping.\r
	492	\r
	493	@retval EFI_SUCCESS The device information is returned.\r
	494	@retval EFI_INVALID_PARAMETER The mapping is invalid.\r
	495	**/\r
	496	EFI_STATUS\r
497	GetDeviceInfoFromMapping (\r
498	IN VOID *Mapping,\r
499	OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,\r
500	OUT UINTN *NumberOfPages\r
501	);\r
502	\r
503	/**\r
504	Initialize DMA protection.\r
505	**/\r
506	VOID\r
507	InitializeDmaProtection (\r
508	VOID\r
509	);\r
510	\r
511	/**\r
512	Allocate zero pages.\r
513	\r
514	@param[in] Pages the number of pages.\r
515	\r
516	@return the page address.\r
517	@retval NULL No resource to allocate pages.\r
518	**/\r
519	VOID *\r
520	EFIAPI\r
521	AllocateZeroPages (\r
522	IN UINTN Pages\r
523	);\r
524	\r
4ad5f597 JY	525	/**\r
	526	Flush VTD page table and context table memory.\r
	527	\r
	528	This action is to make sure the IOMMU engine can get final data in memory.\r
	529	\r
	530	@param[in] VtdIndex The index used to identify a VTd engine.\r
	531	@param[in] Base The base address of memory to be flushed.\r
	532	@param[in] Size The size of memory in bytes to be flushed.\r
	533	**/\r
	534	VOID\r
	535	FlushPageTableMemory (\r
	536	IN UINTN VtdIndex,\r
	537	IN UINTN Base,\r
	538	IN UINTN Size\r
	539	);\r
	540	\r
f77d35c7 JY	541	/**\r
	542	Get PCI device information from DMAR DevScopeEntry.\r
	543	\r
	544	@param[in] Segment The segment number.\r
	545	@param[in] DmarDevScopeEntry DMAR DevScopeEntry\r
	546	@param[out] Bus The bus number.\r
	547	@param[out] Device The device number.\r
	548	@param[out] Function The function number.\r
	549	\r
	550	@retval EFI_SUCCESS The PCI device information is returned.\r
	551	**/\r
	552	EFI_STATUS\r
	553	GetPciBusDeviceFunction (\r
	554	IN UINT16 Segment,\r
	555	IN EFI_ACPI_DMAR_DEVICE_SCOPE_STRUCTURE_HEADER *DmarDevScopeEntry,\r
	556	OUT UINT8 *Bus,\r
	557	OUT UINT8 *Device,\r
	558	OUT UINT8 *Function\r
	559	);\r
	560	\r
c049fc99	561	#endif\r