1. Remove unnecessary CONST.

[mirror_edk2.git] / MdePkg / Include / Ppi / CpuIo.h

diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h
index bf3d5f70368b02b9979c0a100c8341b0e8a7240f..cdb83a92d431a0939e496ebd0f5b2cf49ac523d1 100644 (file)
--- a/MdePkg/Include/Ppi/CpuIo.h
+++ b/MdePkg/Include/Ppi/CpuIo.h
@@ -1,7 +1,8 @@
 /** @file\r
-  This file declares CPU IO PPI that abstracts CPU IO access\r
+  This PPI provides a set of memory- and I/O-based services. \r
+  The perspective of the services is that of the processor, not the bus or system.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -10,8 +11,6 @@
   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 PI.\r
   Version 1.0.\r
@@ -21,16 +20,19 @@
 #ifndef __PEI_CPUIO_PPI_H__\r
 #define __PEI_CPUIO_PPI_H__\r
 \r
+#include <ProcessorBind.h>\r
+#include <Pi/PiPeiCis.h>\r
+\r
 #define EFI_PEI_CPU_IO_PPI_INSTALLED_GUID \\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
-//\r
-// *******************************************************\r
-// EFI_PEI_CPU_IO_PPI_WIDTH\r
-// *******************************************************\r
-//\r
+///\r
+/// *******************************************************\r
+/// EFI_PEI_CPU_IO_PPI_WIDTH\r
+/// *******************************************************\r
+///\r
 typedef enum {\r
   EfiPeiCpuIoWidthUint8,\r
   EfiPeiCpuIoWidthUint16,\r
@@ -63,7 +65,7 @@ typedef enum {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_MEM) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_MEM)(\r
   IN  EFI_PEI_SERVICES                  **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI                *This,\r
   IN  EFI_PEI_CPU_IO_PPI_WIDTH          Width,\r
@@ -72,11 +74,11 @@ EFI_STATUS
   IN  OUT VOID                          *Buffer\r
   );\r
 \r
-//\r
-// *******************************************************\r
-// EFI_PEI_CPU_IO_PPI_ACCESS\r
-// *******************************************************\r
-//\r
+///\r
+/// *******************************************************\r
+/// EFI_PEI_CPU_IO_PPI_ACCESS\r
+/// *******************************************************\r
+///\r
 typedef struct {\r
   EFI_PEI_CPU_IO_PPI_IO_MEM Read;\r
   EFI_PEI_CPU_IO_PPI_IO_MEM Write;\r
@@ -89,12 +91,12 @@ typedef struct {
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
-  @return UINT8\r
+  @return UINT8          An 8-bit value is returned from the I/O space.\r
 \r
 **/\r
 typedef\r
 UINT8\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ8) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ8)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address\r
@@ -107,12 +109,12 @@ UINT8
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
-  @return UINT16\r
+  @return UINT16         A 16-bit value is returned from the I/O space.\r
 \r
 **/\r
 typedef\r
 UINT16\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ16) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ16)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address\r
@@ -125,12 +127,12 @@ UINT16
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
-  @return UINT32\r
+  @return UINT32         A 32-bit value is returned from the I/O space.\r
 \r
 **/\r
 typedef\r
 UINT32\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ32) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ32)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address\r
@@ -143,12 +145,12 @@ UINT32
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
-  @return UINT64\r
+  @return UINT64         A 64-bit value is returned from the I/O space.\r
 \r
 **/\r
 typedef\r
 UINT64\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ64) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ64)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address\r
@@ -167,7 +169,7 @@ UINT64
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE8) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE8)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address,\r
@@ -187,7 +189,7 @@ VOID
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE16) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE16)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address,\r
@@ -207,7 +209,7 @@ VOID
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE32) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE32)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address,\r
@@ -227,7 +229,7 @@ VOID
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE64) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE64)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address,\r
@@ -241,12 +243,12 @@ VOID
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
-  @return UINT8\r
+  @return UINT8          An 8-bit value is returned from the memory space.\r
 \r
 **/\r
 typedef\r
 UINT8\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ8) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ8)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address\r
@@ -259,12 +261,12 @@ UINT8
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
-  @return UINT16\r
+  @return UINT16         A 16-bit value is returned from the memory space.\r
 \r
 **/\r
 typedef\r
 UINT16\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ16) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ16)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address\r
@@ -277,12 +279,12 @@ UINT16
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
-  @return UINT32\r
+  @return UINT32         A 32-bit value is returned from the memory space.\r
 \r
 **/\r
 typedef\r
 UINT32\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ32) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ32)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address\r
@@ -295,12 +297,12 @@ UINT32
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
-  @return UINT64\r
+  @return UINT64         A 64-bit value is returned from the memory space.\r
 \r
 **/\r
 typedef\r
 UINT64\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ64) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ64)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address\r
@@ -319,7 +321,7 @@ UINT64
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE8) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE8)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address,\r
@@ -339,7 +341,7 @@ VOID
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE16) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE16)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address,\r
@@ -359,7 +361,7 @@ VOID
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE32) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE32)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address,\r
@@ -379,7 +381,7 @@ VOID
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE64) (\r
+(EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE64)(\r
   IN  EFI_PEI_SERVICES        **PeiServices,\r
   IN  EFI_PEI_CPU_IO_PPI      *This,\r
   IN  UINT64                  Address,\r
@@ -467,6 +469,6 @@ struct _EFI_PEI_CPU_IO_PPI {
   EFI_PEI_CPU_IO_PPI_MEM_WRITE64  MemWrite64;\r
 };\r
 \r
-extern EFI_GUID gEfiPeiCpuIoPpiInServiceTableGuid;\r
+extern EFI_GUID gEfiPeiCpuIoPpiInstalledGuid;\r
 \r
 #endif\r