]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Ppi/CpuIo.h
Rename EFI_PEI_PCI_CFG_PPI_IO to EFI_PEI_PCI_CFG2_PPI_IO to avoid collision with...
[mirror_edk2.git] / MdePkg / Include / Ppi / CpuIo.h
index 038703386dac72f0b39ff50d71854693526e1059..d34c38d5e08afd70830e636838390aa5e6e2d1a7 100644 (file)
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  CpuIo.h\r
-\r
   @par Revision Reference:\r
-  This PPI is defined in PEI CIS.\r
-  Version 0.91.\r
-\r
+  This PPI is defined in PI.\r
+  Version 1.0.\r
+  \r
 **/\r
 \r
 #ifndef __PEI_CPUIO_PPI_H__\r
 #define __PEI_CPUIO_PPI_H__\r
 \r
 #define EFI_PEI_CPU_IO_PPI_INSTALLED_GUID \\r
-  { \\r
-    0xe6af1f7b, 0xfc3f, 0x46da, {0xa8, 0x28, 0xa3, 0xb4, 0x57, 0xa4, 0x42, 0x82 } \\r
-  }\r
+  { 0xe6af1f7b, 0xfc3f, 0x46da, {0xa8, 0x28, 0xa3, 0xb4, 0x57, 0xa4, 0x42, 0x82 } }\r
 \r
 typedef struct _EFI_PEI_CPU_IO_PPI  EFI_PEI_CPU_IO_PPI;\r
 \r
@@ -52,21 +48,15 @@ typedef enum {
 /**\r
   Memory-based access services and I/O-based access services.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Width The width of the access.  Enumerated in bytes.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Count The number of accesses to perform.\r
-  \r
-  @param  Buffer A pointer to the buffer of data.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Width          The width of the access. Enumerated in bytes.\r
+  @param  Address        The physical address of the access.\r
+  @param  Count          The number of accesses to perform.\r
+  @param  Buffer         A pointer to the buffer of data.\r
 \r
-  @retval EFI_SUCCESS  The function completed successfully. \r
-  \r
-  @retval EFI_NOT_YET_AVAILABLE  The service has not been installed.\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_YET_AVAILABLE The service has not been installed.\r
 \r
 **/\r
 typedef\r
@@ -93,11 +83,9 @@ typedef struct {
 /**\r
   8-bit I/O read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT8\r
 \r
@@ -113,11 +101,9 @@ UINT8
 /**\r
   16-bit I/O read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT16\r
 \r
@@ -133,11 +119,9 @@ UINT16
 /**\r
   32-bit I/O read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT32\r
 \r
@@ -153,11 +137,9 @@ UINT32
 /**\r
   64-bit I/O read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT64\r
 \r
@@ -173,13 +155,10 @@ UINT64
 /**\r
   8-bit I/O write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -196,13 +175,10 @@ VOID
 /**\r
   16-bit I/O write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -219,13 +195,10 @@ VOID
 /**\r
   32-bit I/O write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -242,13 +215,10 @@ VOID
 /**\r
   64-bit I/O write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -265,11 +235,9 @@ VOID
 /**\r
   8-bit Memory read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT8\r
 \r
@@ -285,11 +253,9 @@ UINT8
 /**\r
   16-bit Memory read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT16\r
 \r
@@ -305,11 +271,9 @@ UINT16
 /**\r
   32-bit Memory read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT32\r
 \r
@@ -325,11 +289,9 @@ UINT32
 /**\r
   64-bit Memory read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT64\r
 \r
@@ -345,13 +307,10 @@ UINT64
 /**\r
   8-bit Memory write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -368,13 +327,10 @@ VOID
 /**\r
   16-bit Memory write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -391,13 +347,10 @@ VOID
 /**\r
   32-bit Memory write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -414,13 +367,10 @@ VOID
 /**\r
   64-bit Memory write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r