]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Framework/SmmCis.h
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
index 31dcc93f4e6145b9c31ff2969b021d73cdc69650..60218029692f419b698066bca1c99f94a05d952a 100644 (file)
@@ -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
 \r
 **/\r
 \r
-#ifndef _FRAMEWORK_SMM_CIS_H_\r
-#define _FRAMEWORK_SMM_CIS_H_\r
+#ifndef _SMM_CIS_H_\r
+#define _SMM_CIS_H_\r
 \r
-#include <Framework/DxeCis.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
+// Share some common definitions with PI SMM\r
+//\r
+#include <Pi/PiSmmCis.h>\r
+#include <Protocol/SmmCpuIo.h>\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 SMM_SMST_SIGNATURE            SIGNATURE_32 ('S', 'M', 'S', 'T')\r
 #define EFI_SMM_SYSTEM_TABLE_REVISION (0 << 16) | (0x09)\r
 \r
-//\r
-// *******************************************************\r
-// EFI_SMM_IO_WIDTH\r
-// *******************************************************\r
-//\r
-typedef enum {\r
-  SMM_IO_UINT8  = 0,\r
-  SMM_IO_UINT16 = 1,\r
-  SMM_IO_UINT32 = 2,\r
-  SMM_IO_UINT64 = 3\r
-} EFI_SMM_IO_WIDTH;\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.\r
-                           For write operations, the source buffer from which to write data.\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
 \r
-  @param  PoolType         The type of pool to allocate.The only supported type is EfiRuntimeServicesData\r
+  @param  PoolType         The type of pool to allocate. The only supported type is EfiRuntimeServicesData\r
   @param  Size             The number of bytes to allocate from the pool.\r
   @param  Buffer           A pointer to a pointer to the allocated buffer if the call\r
                            succeeds; undefined otherwise.\r
@@ -104,7 +42,9 @@ 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
-\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
 typedef\r
 EFI_STATUS\r
@@ -122,7 +62,9 @@ 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
-\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
 typedef\r
 EFI_STATUS\r
@@ -145,7 +87,9 @@ 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
-\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
 typedef\r
 EFI_STATUS\r
@@ -165,7 +109,10 @@ EFI_STATUS
   @retval EFI_SUCCESS           The requested memory pages were freed.\r
   @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
+  \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
 typedef\r
 EFI_STATUS\r
@@ -174,14 +121,6 @@ EFI_STATUS
   IN UINTN                  NumberOfPages\r
   );\r
 \r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_STARTUP_THIS_AP)(\r
-  IN  EFI_AP_PROCEDURE                    Procedure,\r
-  IN  UINTN                               CpuNumber,\r
-  IN  OUT VOID                            *ProcArguments OPTIONAL\r
-  );\r
-\r
 ///\r
 /// The processor save-state information for IA-32 processors. This information is important in that the\r
 /// SMM drivers may need to ascertain the state of the processor before invoking the SMI.\r
@@ -542,6 +481,7 @@ struct _EFI_SMM_SYSTEM_TABLE {
   // Runtime memory service\r
   //\r
   ///\r
+  ///\r
   /// Allocates pool memory from SMRAM for IA-32 or runtime memory for the\r
   /// Itanium processor family.\r
   ///\r
@@ -562,6 +502,10 @@ struct _EFI_SMM_SYSTEM_TABLE {
   //\r
   // MP service\r
   //\r
+  \r
+  ///Inconsistent with specification here:\r
+  ///  In Framework Spec, this definition does not exist. This method is introduced in PI1.1 spec for \r
+  ///  implementation needed.\r
   EFI_SMM_STARTUP_THIS_AP             SmmStartupThisAp;\r
 \r
   //\r