MdeModulePkg: Introduce EDKII_SERIAL_PORT_LIB_VENDOR_GUID

[mirror_edk2.git] / MdeModulePkg / Include / Ppi / IoMmu.h

/** @file\r
  PEI IOMMU PPI.\r
\r
Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#ifndef __PEI_IOMMU_H__\r
#define __PEI_IOMMU_H__\r
\r
//\r
// for EFI_ALLOCATE_TYPE\r
//\r
#include <Uefi.h>\r
\r
//\r
// Include protocol for common definition\r
//   EDKII_IOMMU_ACCESS_xxx\r
//   EDKII_IOMMU_OPERATION\r
//\r
#include <Protocol/IoMmu.h>\r
\r
//\r
// IOMMU Ppi GUID value\r
//\r
#define EDKII_IOMMU_PPI_GUID \\r
    { \\r
      0x70b0af26, 0xf847, 0x4bb6, { 0xaa, 0xb9, 0xcd, 0xe8, 0x4f, 0xc6, 0x14, 0x31 } \\r
    }\r
\r
//\r
// Forward reference for pure ANSI compatability\r
//\r
typedef struct _EDKII_IOMMU_PPI  EDKII_IOMMU_PPI;\r
\r
//\r
// Revision The revision to which the IOMMU interface adheres.\r
//          All future revisions must be backwards compatible.\r
//          If a future version is not back wards compatible it is not the same GUID.\r
//\r
#define EDKII_IOMMU_PPI_REVISION 0x00010000\r
\r
/**\r
  Set IOMMU attribute for a system memory.\r
\r
  If the IOMMU PPI exists, the system memory cannot be used\r
  for DMA by default.\r
\r
  When a device requests a DMA access for a system memory,\r
  the device driver need use SetAttribute() to update the IOMMU\r
  attribute to request DMA access (read and/or write).\r
\r
  @param[in]  This              The PPI instance pointer.\r
  @param[in]  Mapping           The mapping value returned from Map().\r
  @param[in]  IoMmuAccess       The IOMMU access.\r
\r
  @retval EFI_SUCCESS            The IoMmuAccess is set for the memory range specified by DeviceAddress and Length.\r
  @retval EFI_INVALID_PARAMETER  Mapping is not a value that was returned by Map().\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 Mapping.\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
  @retval EFI_NOT_AVAILABLE_YET  DMA protection has been enabled, but DMA buffer are\r
                                 not available to be allocated yet.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EDKII_PEI_IOMMU_SET_ATTRIBUTE)(\r
  IN EDKII_IOMMU_PPI       *This,\r
  IN VOID                  *Mapping,\r
  IN UINT64                IoMmuAccess\r
  );\r
\r
/**\r
  Provides the controller-specific addresses required to access system memory from a\r
  DMA bus master.\r
\r
  @param  This                  The PPI instance pointer.\r
  @param  Operation             Indicates if the bus master is going to read or write to system memory.\r
  @param  HostAddress           The system memory address to map to the PCI controller.\r
  @param  NumberOfBytes         On input the number of bytes to map. On output the number of bytes\r
                                that were mapped.\r
  @param  DeviceAddress         The resulting map address for the bus master PCI controller to use to\r
                                access the hosts HostAddress.\r
  @param  Mapping               A resulting value to pass to Unmap().\r
\r
  @retval EFI_SUCCESS           The range was mapped for the returned NumberOfBytes.\r
  @retval EFI_UNSUPPORTED       The HostAddress cannot be mapped as a common buffer.\r
  @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
  @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.\r
  @retval EFI_DEVICE_ERROR      The system hardware could not map the requested address.\r
  @retval EFI_NOT_AVAILABLE_YET DMA protection has been enabled, but DMA buffer are\r
                                not available to be allocated yet.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EDKII_PEI_IOMMU_MAP)(\r
  IN     EDKII_IOMMU_PPI                            *This,\r
  IN     EDKII_IOMMU_OPERATION                      Operation,\r
  IN     VOID                                       *HostAddress,\r
  IN OUT UINTN                                      *NumberOfBytes,\r
  OUT    EFI_PHYSICAL_ADDRESS                       *DeviceAddress,\r
  OUT    VOID                                       **Mapping\r
  );\r
\r
/**\r
  Completes the Map() operation and releases any corresponding resources.\r
\r
  @param  This                  The PPI instance pointer.\r
  @param  Mapping               The mapping value returned from Map().\r
\r
  @retval EFI_SUCCESS           The range was unmapped.\r
  @retval EFI_INVALID_PARAMETER Mapping is not a value that was returned by Map().\r
  @retval EFI_DEVICE_ERROR      The data was not committed to the target system memory.\r
  @retval EFI_NOT_AVAILABLE_YET DMA protection has been enabled, but DMA buffer are\r
                                not available to be allocated yet.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EDKII_PEI_IOMMU_UNMAP)(\r
  IN  EDKII_IOMMU_PPI                          *This,\r
  IN  VOID                                     *Mapping\r
  );\r
\r
/**\r
  Allocates pages that are suitable for an OperationBusMasterCommonBuffer or\r
  OperationBusMasterCommonBuffer64 mapping.\r
\r
  @param  This                  The PPI instance pointer.\r
  @param  MemoryType            The type of memory to allocate, EfiBootServicesData or\r
                                EfiRuntimeServicesData.\r
  @param  Pages                 The number of pages to allocate.\r
  @param  HostAddress           A pointer to store the base system memory address of the\r
                                allocated range.\r
  @param  Attributes            The requested bit mask of attributes for the allocated range.\r
\r
  @retval EFI_SUCCESS           The requested memory pages were allocated.\r
  @retval EFI_UNSUPPORTED       Attributes is unsupported. The only legal attribute bits are\r
                                MEMORY_WRITE_COMBINE, MEMORY_CACHED and DUAL_ADDRESS_CYCLE.\r
  @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
  @retval EFI_OUT_OF_RESOURCES  The memory pages could not be allocated.\r
  @retval EFI_NOT_AVAILABLE_YET DMA protection has been enabled, but DMA buffer are\r
                                not available to be allocated yet.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EDKII_PEI_IOMMU_ALLOCATE_BUFFER)(\r
  IN     EDKII_IOMMU_PPI                          *This,\r
  IN     EFI_MEMORY_TYPE                          MemoryType,\r
  IN     UINTN                                    Pages,\r
  IN OUT VOID                                     **HostAddress,\r
  IN     UINT64                                   Attributes\r
  );\r
\r
/**\r
  Frees memory that was allocated with AllocateBuffer().\r
\r
  @param  This                  The PPI instance pointer.\r
  @param  Pages                 The number of pages to free.\r
  @param  HostAddress           The base system memory address of the allocated range.\r
\r
  @retval EFI_SUCCESS           The requested memory pages were freed.\r
  @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages\r
                                was not allocated with AllocateBuffer().\r
  @retval EFI_NOT_AVAILABLE_YET DMA protection has been enabled, but DMA buffer are\r
                                not available to be allocated yet.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EDKII_PEI_IOMMU_FREE_BUFFER)(\r
  IN  EDKII_IOMMU_PPI                          *This,\r
  IN  UINTN                                    Pages,\r
  IN  VOID                                     *HostAddress\r
  );\r
\r
///\r
/// IOMMU PPI structure.\r
///\r
struct _EDKII_IOMMU_PPI {\r
  UINT64                              Revision;\r
  EDKII_PEI_IOMMU_SET_ATTRIBUTE       SetAttribute;\r
  EDKII_PEI_IOMMU_MAP                 Map;\r
  EDKII_PEI_IOMMU_UNMAP               Unmap;\r
  EDKII_PEI_IOMMU_ALLOCATE_BUFFER     AllocateBuffer;\r
  EDKII_PEI_IOMMU_FREE_BUFFER         FreeBuffer;\r
};\r
\r
///\r
/// IOMMU PPI GUID variable.\r
///\r
extern EFI_GUID gEdkiiIoMmuPpiGuid;\r
\r
#endif\r