Put Framework SMM CPU I/O Protocol into its own .h file and add the GUID for this...

[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / SmmCis.h

diff --git a/IntelFrameworkPkg/Include/Framework/SmmCis.h b/IntelFrameworkPkg/Include/Framework/SmmCis.h
index 59cc701dbefe72d6fd8b1b3651844c7b8465609f..60218029692f419b698066bca1c99f94a05d952a 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/SmmCis.h
+++ b/IntelFrameworkPkg/Include/Framework/SmmCis.h
@@ -2,7 +2,7 @@
   Include file for definitions in the Intel Platform Innovation Framework for EFI\r
   System Management Mode Core Interface Specification (SMM CIS) version 0.90.\r
 \r
-  Copyright (c) 2007 - 2009, Intel Corporation\r
+  Copyright (c) 2007 - 2010, 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
@@ -22,67 +22,14 @@
 #include <Pi/PiSmmCis.h>\r
 #include <Protocol/SmmCpuIo.h>\r
 \r
-#define EFI_SMM_CPU_IO_GUID \\r
-  { \\r
-    0x5f439a0b, 0x45d8, 0x4682, {0xa4, 0xf4, 0xf0, 0x57, 0x6b, 0x51, 0x34, 0x41 } \\r
-  }\r
-\r
 typedef struct _EFI_SMM_SYSTEM_TABLE      EFI_SMM_SYSTEM_TABLE;\r
 typedef struct _EFI_SMM_CPU_IO_INTERFACE  EFI_SMM_CPU_IO_INTERFACE;\r
 \r
-\r
 //\r
 // SMM Base specification constant and types\r
 //\r
 #define EFI_SMM_SYSTEM_TABLE_REVISION (0 << 16) | (0x09)\r
 \r
-/**\r
-  Provides the basic memory and I/O interfaces that are used to\r
-  abstract accesses to devices.\r
-\r
-  @param  This             The EFI_SMM_CPU_IO_INTERFACE instance.\r
-  @param  Width            Signifies the width of the I/O operations.\r
-  @param  Address          The base address of the I/O operations.\r
-  @param  Count            The number of I/O operations to perform.\r
-  @param  Buffer           For read operations, the destination buffer to store the results (out parameter).\r
-                           For write operations, the source buffer from which to write data (in parameter).\r
-\r
-  @retval EFI_SUCCESS           The data was read from or written to the device.\r
-  @retval EFI_UNSUPPORTED       The Address is not valid for this system.\r
-  @retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.\r
-  @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_CPU_IO)(\r
-  IN EFI_SMM_CPU_IO_INTERFACE         *This,\r
-  IN EFI_SMM_IO_WIDTH                 Width,\r
-  IN UINT64                           Address,\r
-  IN UINTN                            Count,\r
-  IN OUT VOID                         *Buffer\r
-  );\r
-\r
-typedef struct {\r
-  EFI_SMM_CPU_IO  Read;  ///< This service provides the various modalities of memory and I/O read.\r
-  EFI_SMM_CPU_IO  Write; ///< This service provides the various modalities of memory and I/O write.\r
-} EFI_SMM_IO_ACCESS;\r
-\r
-///\r
-/// The EFI_SMM_CPU_IO_INTERFACE service provides the basic memory, I/O, and PCI\r
-/// interfaces that are used to abstract accesses to devices.\r
-///\r
-struct _EFI_SMM_CPU_IO_INTERFACE {\r
-  ///\r
-  /// Allows reads and writes to memory-mapped I/O space. \r
-  ///\r
-  EFI_SMM_IO_ACCESS Mem;\r
-  ///\r
-  /// Allows reads and writes to I/O space. \r
-  ///\r
-  EFI_SMM_IO_ACCESS Io;\r
-};\r
-\r
 /**\r
   Allocates pool memory from SMRAM for IA-32 or runtime memory for\r
   the Itanium processor family.\r
@@ -95,7 +42,7 @@ struct _EFI_SMM_CPU_IO_INTERFACE {
   @retval EFI_SUCCESS           The requested number of bytes was allocated.\r
   @retval EFI_OUT_OF_RESOURCES  The pool requested could not be allocated.\r
   @retval EFI_UNSUPPORTED       In runtime.\r
-  @note: Inconsistent with specification here:\r
+  @note  Inconsistent with specification here:\r
          In Framework Spec, this definition is named EFI_SMM_ALLOCATE_POOL.  \r
          To avoid a naming conflict, the definition is renamed.\r
 **/\r
@@ -115,7 +62,7 @@ EFI_STATUS
   @retval EFI_SUCCESS           The memory was returned to the system.\r
   @retval EFI_INVALID_PARAMETER Buffer was invalid.\r
   @retval EFI_UNSUPPORTED       In runtime.\r
-  @note: Inconsistent with specification here:\r
+  @note  Inconsistent with specification here:\r
          In Framework Spec, this definition is named EFI_SMM_FREE_POOL.  \r
          To avoid a naming conflict, the definition is renamed. \r
 **/\r
@@ -140,7 +87,7 @@ EFI_STATUS
   @retval EFI_NOT_FOUND         The requested pages could not be found.\r
   @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress\r
                                 or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
-  @note: Inconsistent with specification here:\r
+  @note  Inconsistent with specification here:\r
          In the Framework Spec, this definition is named EFI_SMM_ALLOCATE_PAGES.  \r
          To avoid a naming conflict, the definition here is renamed.\r
 **/\r
@@ -163,7 +110,7 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.\r
   @retval EFI_NOT_FOUND         The requested memory pages were not allocated with SmmAllocatePages().\r
   \r
-  @note: Inconsistent with specification here:\r
+  @note  Inconsistent with specification here:\r
          In the Framework Spec, this definition is named EFI_SMM_FREE_PAGES.  \r
          To avoid a naming conflict, the definition here is renamed.\r
 **/\r