[mirror_edk2.git] / IntelSiliconPkg / 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/AcpiSystemDescriptionTable.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 descriptor.\r
// The number may be enlarged later.\r
//\r
#define MAX_PCI_DESCRIPTORS             0x100\r
\r
typedef struct {\r
  BOOLEAN                IncludeAllFlag;\r
  UINTN                  PciDescriptorNumber;\r
  UINTN                  PciDescriptorMaxNumber;\r
  BOOLEAN                *IsRealPciDevice;\r
  VTD_SOURCE_ID          *PciDescriptors;\r
  // for statistic analysis\r
  UINTN                  *AccessCount;\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
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 as PCI descriptor.\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]  IsRealPciDevice       TRUE: It is a real PCI device.\r
                                    FALSE: It is not a real PCI device.\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 BOOLEAN        IsRealPciDevice,\r
  IN BOOLEAN        CheckExist\r
  );\r
\r
/**\r
  Scan PCI bus and register PCI devices under the bus.\r
\r
  @param[in]  VtdIndex              The index of VTd engine.\r
  @param[in]  Segment               The segment of the source.\r
  @param[in]  Bus                   The bus of the source.\r
\r
  @retval EFI_SUCCESS           The PCI devices under the bus are registered.\r
  @retval EFI_OUT_OF_RESOURCES  No enough resource to register a new PCI device.\r
**/\r
EFI_STATUS\r
ScanPciBus (\r
  IN UINTN          VtdIndex,\r
  IN UINT16         Segment,\r
  IN UINT8          Bus\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 PCI descriptor.\r
  @retval (UINTN)-1  The PCI descriptor 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 descriptor.\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 descriptor.\r
  @retval (UINTN)-1  The PCI descriptor is not found.\r
**/\r
UINTN\r
GetPciDescriptor (\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
#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
	39	#include <Protocol/AcpiSystemDescriptionTable.h>\r
	40	#include <Protocol/PlatformVtdPolicy.h>\r
	41	#include <Protocol/IoMmu.h>\r
	42	\r
	43	#include <IndustryStandard/Pci.h>\r
	44	#include <IndustryStandard/DmaRemappingReportingTable.h>\r
	45	#include <IndustryStandard/Vtd.h>\r
	46	\r
76c6f69c SZ	47	#define VTD_64BITS_ADDRESS(Lo, Hi) (LShiftU64 (Lo, 12) \| LShiftU64 (Hi, 32))\r
76c6f69c SZ	48	\r
c049fc99 JY	49	#define ALIGN_VALUE_UP(Value, Alignment) (((Value) + (Alignment) - 1) & (~((Alignment) - 1)))\r
	50	#define ALIGN_VALUE_LOW(Value, Alignment) ((Value) & (~((Alignment) - 1)))\r
	51	\r
	52	//\r
	53	// This is the initial max PCI descriptor.\r
	54	// The number may be enlarged later.\r
	55	//\r
	56	#define MAX_PCI_DESCRIPTORS 0x100\r
	57	\r
	58	typedef struct {\r
	59	BOOLEAN IncludeAllFlag;\r
	60	UINTN PciDescriptorNumber;\r
	61	UINTN PciDescriptorMaxNumber;\r
	62	BOOLEAN *IsRealPciDevice;\r
	63	VTD_SOURCE_ID *PciDescriptors;\r
4ad5f597 JY	64	// for statistic analysis\r
4ad5f597 JY	65	UINTN *AccessCount;\r
c049fc99 JY	66	} PCI_DEVICE_INFORMATION;\r
	67	\r
	68	typedef struct {\r
	69	UINTN VtdUnitBaseAddress;\r
	70	UINT16 Segment;\r
	71	VTD_CAP_REG CapReg;\r
	72	VTD_ECAP_REG ECapReg;\r
	73	VTD_ROOT_ENTRY *RootEntryTable;\r
	74	VTD_EXT_ROOT_ENTRY *ExtRootEntryTable;\r
	75	VTD_SECOND_LEVEL_PAGING_ENTRY *FixedSecondLevelPagingEntry;\r
4ad5f597	76	BOOLEAN HasDirtyContext;\r
c049fc99 JY	77	BOOLEAN HasDirtyPages;\r
	78	PCI_DEVICE_INFORMATION PciDeviceInfo;\r
	79	} VTD_UNIT_INFORMATION;\r
	80	\r
	81	extern EFI_ACPI_DMAR_HEADER *mAcpiDmarTable;\r
	82	\r
	83	extern UINT64 mVtdHostAddressWidthMask;\r
	84	extern UINTN mVtdUnitNumber;\r
	85	extern VTD_UNIT_INFORMATION *mVtdUnitInformation;\r
	86	\r
	87	extern UINT64 mBelow4GMemoryLimit;\r
	88	extern UINT64 mAbove4GMemoryLimit;\r
	89	\r
	90	extern EDKII_PLATFORM_VTD_POLICY_PROTOCOL *mPlatformVTdPolicy;\r
	91	\r
	92	/**\r
	93	Prepare VTD configuration.\r
	94	**/\r
	95	VOID\r
	96	PrepareVtdConfig (\r
	97	VOID\r
	98	);\r
	99	\r
	100	/**\r
	101	Setup VTd translation table.\r
	102	\r
	103	@retval EFI_SUCCESS Setup translation table successfully.\r
	104	@retval EFI_OUT_OF_RESOURCE Setup translation table fail.\r
	105	**/\r
	106	EFI_STATUS\r
	107	SetupTranslationTable (\r
	108	VOID\r
	109	);\r
	110	\r
	111	/**\r
	112	Enable DMAR translation.\r
	113	\r
	114	@retval EFI_SUCCESS DMAR translation is enabled.\r
	115	@retval EFI_DEVICE_ERROR DMAR translation is not enabled.\r
	116	**/\r
	117	EFI_STATUS\r
	118	EnableDmar (\r
	119	VOID\r
	120	);\r
	121	\r
	122	/**\r
	123	Disable DMAR translation.\r
	124	\r
	125	@retval EFI_SUCCESS DMAR translation is disabled.\r
	126	@retval EFI_DEVICE_ERROR DMAR translation is not disabled.\r
	127	**/\r
	128	EFI_STATUS\r
	129	DisableDmar (\r
	130	VOID\r
	131	);\r
	132	\r
c049fc99 JY	133	/**\r
	134	Invalid VTd global IOTLB.\r
	135	\r
	136	@param[in] VtdIndex The index of VTd engine.\r
	137	\r
	138	@retval EFI_SUCCESS VTd global IOTLB is invalidated.\r
	139	@retval EFI_DEVICE_ERROR VTd global IOTLB is not invalidated.\r
	140	**/\r
	141	EFI_STATUS\r
	142	InvalidateVtdIOTLBGlobal (\r
	143	IN UINTN VtdIndex\r
	144	);\r
	145	\r
	146	/**\r
	147	Dump VTd registers.\r
	148	\r
	149	@param[in] VtdIndex The index of VTd engine.\r
	150	**/\r
	151	VOID\r
	152	DumpVtdRegs (\r
	153	IN UINTN VtdIndex\r
	154	);\r
	155	\r
	156	/**\r
	157	Dump VTd registers for all VTd engine.\r
	158	**/\r
	159	VOID\r
	160	DumpVtdRegsAll (\r
	161	VOID\r
	162	);\r
	163	\r
	164	/**\r
	165	Dump VTd capability registers.\r
	166	\r
	167	@param[in] CapReg The capability register.\r
	168	**/\r
	169	VOID\r
	170	DumpVtdCapRegs (\r
	171	IN VTD_CAP_REG *CapReg\r
	172	);\r
	173	\r
	174	/**\r
	175	Dump VTd extended capability registers.\r
	176	\r
	177	@param[in] ECapReg The extended capability register.\r
	178	**/\r
	179	VOID\r
	180	DumpVtdECapRegs (\r
	181	IN VTD_ECAP_REG *ECapReg\r
	182	);\r
	183	\r
	184	/**\r
	185	Register PCI device to VTd engine as PCI descriptor.\r
	186	\r
	187	@param[in] VtdIndex The index of VTd engine.\r
	188	@param[in] Segment The segment of the source.\r
	189	@param[in] SourceId The SourceId of the source.\r
	190	@param[in] IsRealPciDevice TRUE: It is a real PCI device.\r
	191	FALSE: It is not a real PCI device.\r
	192	@param[in] CheckExist TRUE: ERROR will be returned if the PCI device is already registered.\r
	193	FALSE: SUCCESS will be returned if the PCI device is registered.\r
	194	\r
	195	@retval EFI_SUCCESS The PCI device is registered.\r
	196	@retval EFI_OUT_OF_RESOURCES No enough resource to register a new PCI device.\r
197	@retval EFI_ALREADY_STARTED The device is already registered.\r
198	**/\r
199	EFI_STATUS\r
200	RegisterPciDevice (\r
201	IN UINTN VtdIndex,\r
202	IN UINT16 Segment,\r
203	IN VTD_SOURCE_ID SourceId,\r
204	IN BOOLEAN IsRealPciDevice,\r
205	IN BOOLEAN CheckExist\r
206	);\r
207	\r
208	/**\r
209	Scan PCI bus and register PCI devices under the bus.\r
210	\r
211	@param[in] VtdIndex The index of VTd engine.\r
212	@param[in] Segment The segment of the source.\r
213	@param[in] Bus The bus of the source.\r
214	\r
215	@retval EFI_SUCCESS The PCI devices under the bus are registered.\r
216	@retval EFI_OUT_OF_RESOURCES No enough resource to register a new PCI device.\r
217	**/\r
218	EFI_STATUS\r
219	ScanPciBus (\r
220	IN UINTN VtdIndex,\r
221	IN UINT16 Segment,\r
222	IN UINT8 Bus\r
223	);\r
224	\r
225	/**\r
226	Dump the PCI device information managed by this VTd engine.\r
227	\r
228	@param[in] VtdIndex The index of VTd engine.\r
229	**/\r
230	VOID\r
231	DumpPciDeviceInfo (\r
232	IN UINTN VtdIndex\r
233	);\r
234	\r
235	/**\r
236	Find the VTd index by the Segment and SourceId.\r
237	\r
238	@param[in] Segment The segment of the source.\r
239	@param[in] SourceId The SourceId of the source.\r
240	@param[out] ExtContextEntry The ExtContextEntry of the source.\r
241	@param[out] ContextEntry The ContextEntry of the source.\r
242	\r
243	@return The index of the PCI descriptor.\r
244	@retval (UINTN)-1 The PCI descriptor is not found.\r
245	**/\r
246	UINTN\r
247	FindVtdIndexByPciDevice (\r
248	IN UINT16 Segment,\r
249	IN VTD_SOURCE_ID SourceId,\r
250	OUT VTD_EXT_CONTEXT_ENTRY **ExtContextEntry,\r
251	OUT VTD_CONTEXT_ENTRY **ContextEntry\r
252	);\r
253	\r
254	/**\r
255	Get the DMAR ACPI table.\r
256	\r
257	@retval EFI_SUCCESS The DMAR ACPI table is got.\r
258	@retval EFI_NOT_FOUND The DMAR ACPI table is not found.\r
259	**/\r
260	EFI_STATUS\r
261	GetDmarAcpiTable (\r
262	VOID\r
263	);\r
264	\r
265	/**\r
266	Parse DMAR DRHD table.\r
267	\r
268	@return EFI_SUCCESS The DMAR DRHD table is parsed.\r
269	**/\r
270	EFI_STATUS\r
271	ParseDmarAcpiTableDrhd (\r
272	VOID\r
273	);\r
274	\r
275	/**\r
276	Parse DMAR RMRR table.\r
277	\r
278	@return EFI_SUCCESS The DMAR RMRR table is parsed.\r
279	**/\r
280	EFI_STATUS\r
281	ParseDmarAcpiTableRmrr (\r
282	VOID\r
283	);\r
284	\r
285	/**\r
286	Dump DMAR context entry table.\r
287	\r
288	@param[in] RootEntry DMAR root entry.\r
289	**/\r
290	VOID\r
291	DumpDmarContextEntryTable (\r
292	IN VTD_ROOT_ENTRY *RootEntry\r
293	);\r
294	\r
295	/**\r
296	Dump DMAR extended context entry table.\r
297	\r
298	@param[in] ExtRootEntry DMAR extended root entry.\r
299	**/\r
300	VOID\r
301	DumpDmarExtContextEntryTable (\r
302	IN VTD_EXT_ROOT_ENTRY *ExtRootEntry\r
303	);\r
304	\r
305	/**\r
306	Dump DMAR second level paging entry.\r
307	\r
308	@param[in] SecondLevelPagingEntry The second level paging entry.\r
309	**/\r
310	VOID\r
311	DumpSecondLevelPagingEntry (\r
312	IN VOID *SecondLevelPagingEntry\r
313	);\r
314	\r
315	/**\r
316	Set VTd attribute for a system memory.\r
317	\r
318	@param[in] VtdIndex The index used to identify a VTd engine.\r
d654bf85	319	@param[in] DomainIdentifier The domain ID of the source.\r
c049fc99 JY	320	@param[in] SecondLevelPagingEntry The second level paging entry in VTd table for the device.\r
	321	@param[in] BaseAddress The base of device memory address to be used as the DMA memory.\r
	322	@param[in] Length The length of device memory address to be used as the DMA memory.\r
	323	@param[in] IoMmuAccess The IOMMU access.\r
	324	\r
	325	@retval EFI_SUCCESS The IoMmuAccess is set for the memory range specified by BaseAddress and Length.\r
	326	@retval EFI_INVALID_PARAMETER BaseAddress is not IoMmu Page size aligned.\r
	327	@retval EFI_INVALID_PARAMETER Length is not IoMmu Page size aligned.\r
	328	@retval EFI_INVALID_PARAMETER Length is 0.\r
	329	@retval EFI_INVALID_PARAMETER IoMmuAccess specified an illegal combination of access.\r
	330	@retval EFI_UNSUPPORTED The bit mask of IoMmuAccess is not supported by the IOMMU.\r
	331	@retval EFI_UNSUPPORTED The IOMMU does not support the memory range specified by BaseAddress and Length.\r
	332	@retval EFI_OUT_OF_RESOURCES There are not enough resources available to modify the IOMMU access.\r
	333	@retval EFI_DEVICE_ERROR The IOMMU device reported an error while attempting the operation.\r
	334	**/\r
	335	EFI_STATUS\r
	336	SetPageAttribute (\r
	337	IN UINTN VtdIndex,\r
4ad5f597	338	IN UINT16 DomainIdentifier,\r
c049fc99 JY	339	IN VTD_SECOND_LEVEL_PAGING_ENTRY *SecondLevelPagingEntry,\r
	340	IN UINT64 BaseAddress,\r
	341	IN UINT64 Length,\r
	342	IN UINT64 IoMmuAccess\r
	343	);\r
	344	\r
	345	/**\r
	346	Set VTd attribute for a system memory.\r
	347	\r
	348	@param[in] Segment The Segment used to identify a VTd engine.\r
	349	@param[in] SourceId The SourceId used to identify a VTd engine and table entry.\r
	350	@param[in] BaseAddress The base of device memory address to be used as the DMA memory.\r
	351	@param[in] Length The length of device memory address to be used as the DMA memory.\r
	352	@param[in] IoMmuAccess The IOMMU access.\r
	353	\r
	354	@retval EFI_SUCCESS The IoMmuAccess is set for the memory range specified by BaseAddress and Length.\r
	355	@retval EFI_INVALID_PARAMETER BaseAddress is not IoMmu Page size aligned.\r
	356	@retval EFI_INVALID_PARAMETER Length is not IoMmu Page size aligned.\r
	357	@retval EFI_INVALID_PARAMETER Length is 0.\r
	358	@retval EFI_INVALID_PARAMETER IoMmuAccess specified an illegal combination of access.\r
	359	@retval EFI_UNSUPPORTED The bit mask of IoMmuAccess is not supported by the IOMMU.\r
	360	@retval EFI_UNSUPPORTED The IOMMU does not support the memory range specified by BaseAddress and Length.\r
	361	@retval EFI_OUT_OF_RESOURCES There are not enough resources available to modify the IOMMU access.\r
	362	@retval EFI_DEVICE_ERROR The IOMMU device reported an error while attempting the operation.\r
	363	**/\r
	364	EFI_STATUS\r
	365	SetAccessAttribute (\r
	366	IN UINT16 Segment,\r
	367	IN VTD_SOURCE_ID SourceId,\r
	368	IN UINT64 BaseAddress,\r
	369	IN UINT64 Length,\r
	370	IN UINT64 IoMmuAccess\r
	371	);\r
	372	\r
	373	/**\r
	374	Return the index of PCI descriptor.\r
	375	\r
	376	@param[in] VtdIndex The index used to identify a VTd engine.\r
	377	@param[in] Segment The Segment used to identify a VTd engine.\r
	378	@param[in] SourceId The SourceId used to identify a VTd engine and table entry.\r
	379	\r
	380	@return The index of the PCI descriptor.\r
	381	@retval (UINTN)-1 The PCI descriptor is not found.\r
	382	**/\r
	383	UINTN\r
	384	GetPciDescriptor (\r
	385	IN UINTN VtdIndex,\r
	386	IN UINT16 Segment,\r
	387	IN VTD_SOURCE_ID SourceId\r
	388	);\r
	389	\r
	390	/**\r
	391	Dump VTd registers if there is error.\r
	392	**/\r
	393	VOID\r
	394	DumpVtdIfError (\r
	395	VOID\r
	396	);\r
	397	\r
	398	/**\r
	399	Initialize platform VTd policy.\r
	400	**/\r
	401	VOID\r
	402	InitializePlatformVTdPolicy (\r
403	VOID\r
404	);\r
405	\r
406	/**\r
407	Always enable the VTd page attribute for the device.\r
408	\r
409	@param[in] Segment The Segment used to identify a VTd engine.\r
410	@param[in] SourceId The SourceId used to identify a VTd engine and table entry.\r
411	\r
412	@retval EFI_SUCCESS The VTd entry is updated to always enable all DMA access for the specific device.\r
413	**/\r
414	EFI_STATUS\r
415	AlwaysEnablePageAttribute (\r
416	IN UINT16 Segment,\r
417	IN VTD_SOURCE_ID SourceId\r
418	);\r
419	\r
420	/**\r
421	Convert the DeviceHandle to SourceId and Segment.\r
422	\r
423	@param[in] DeviceHandle The device who initiates the DMA access request.\r
424	@param[out] Segment The Segment used to identify a VTd engine.\r
425	@param[out] SourceId The SourceId used to identify a VTd engine and table entry.\r
426	\r
427	@retval EFI_SUCCESS The Segment and SourceId are returned.\r
428	@retval EFI_INVALID_PARAMETER DeviceHandle is an invalid handle.\r
429	@retval EFI_UNSUPPORTED DeviceHandle is unknown by the IOMMU.\r
430	**/\r
431	EFI_STATUS\r
432	DeviceHandleToSourceId (\r
433	IN EFI_HANDLE DeviceHandle,\r
434	OUT UINT16 *Segment,\r
435	OUT VTD_SOURCE_ID *SourceId\r
436	);\r
437	\r
438	/**\r
439	Get device information from mapping.\r
440	\r
441	@param[in] Mapping The mapping.\r
442	@param[out] DeviceAddress The device address of the mapping.\r
443	@param[out] NumberOfPages The number of pages of the mapping.\r
444	\r
445	@retval EFI_SUCCESS The device information is returned.\r
446	@retval EFI_INVALID_PARAMETER The mapping is invalid.\r
447	**/\r
448	EFI_STATUS\r
449	GetDeviceInfoFromMapping (\r
450	IN VOID *Mapping,\r
451	OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,\r
452	OUT UINTN *NumberOfPages\r
453	);\r
454	\r
455	/**\r
456	Initialize DMA protection.\r
457	**/\r
458	VOID\r
459	InitializeDmaProtection (\r
460	VOID\r
461	);\r
462	\r
463	/**\r
464	Allocate zero pages.\r
465	\r
466	@param[in] Pages the number of pages.\r
467	\r
468	@return the page address.\r
469	@retval NULL No resource to allocate pages.\r
470	**/\r
471	VOID *\r
472	EFIAPI\r
473	AllocateZeroPages (\r
474	IN UINTN Pages\r
475	);\r
476	\r
4ad5f597 JY	477	/**\r
	478	Flush VTD page table and context table memory.\r
	479	\r
	480	This action is to make sure the IOMMU engine can get final data in memory.\r
	481	\r
	482	@param[in] VtdIndex The index used to identify a VTd engine.\r
	483	@param[in] Base The base address of memory to be flushed.\r
	484	@param[in] Size The size of memory in bytes to be flushed.\r
	485	**/\r
	486	VOID\r
	487	FlushPageTableMemory (\r
	488	IN UINTN VtdIndex,\r
	489	IN UINTN Base,\r
	490	IN UINTN Size\r
	491	);\r
	492	\r
c049fc99	493	#endif\r