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