Rename PI SMM definitions which has same name with those of Framework SMM spec but with different content (Note these renamings are not yet in public PI spec or errata now); Remove common definitions shared between PI and Framework Spec from include files for Framework SMM Spec, and change includes files for Framework SMM Spec to include PI SMM include files. The goal is to allow a module include both PI and Framework SMM definitions without conflict.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9453 6f19259b-4bc3-4df7-8a09-765794883524

6 files changed, 24 insertions, 112 deletions

diff --git a/IntelFrameworkPkg/Include/Framework/SmmCis.h b/IntelFrameworkPkg/Include/Framework/SmmCis.h
index b8fce5494e..59cc701dbe 100644
--- a/IntelFrameworkPkg/Include/Framework/SmmCis.h
+++ b/IntelFrameworkPkg/Include/Framework/SmmCis.h
@@ -16,6 +16,12 @@
 #ifndef _SMM_CIS_H_

 #define _SMM_CIS_H_

 

+//

+// Share some common definitions with PI SMM

+//

+#include <Pi/PiSmmCis.h>

+#include <Protocol/SmmCpuIo.h>

+

 #define EFI_SMM_CPU_IO_GUID \

   { \

     0x5f439a0b, 0x45d8, 0x4682, {0xa4, 0xf4, 0xf0, 0x57, 0x6b, 0x51, 0x34, 0x41 } \

@@ -28,21 +34,8 @@ typedef struct _EFI_SMM_CPU_IO_INTERFACE  EFI_SMM_CPU_IO_INTERFACE;
 //

 // SMM Base specification constant and types

 //

-#define SMM_SMST_SIGNATURE            SIGNATURE_32 ('S', 'M', 'S', 'T')

 #define EFI_SMM_SYSTEM_TABLE_REVISION (0 << 16) | (0x09)

 

-//

-// *******************************************************

-// EFI_SMM_IO_WIDTH

-// *******************************************************

-//

-typedef enum {

-  SMM_IO_UINT8  = 0,

-  SMM_IO_UINT16 = 1,

-  SMM_IO_UINT32 = 2,

-  SMM_IO_UINT64 = 3

-} EFI_SMM_IO_WIDTH;

-

 /**

   Provides the basic memory and I/O interfaces that are used to

   abstract accesses to devices.

@@ -181,35 +174,6 @@ EFI_STATUS
   IN UINTN                  NumberOfPages

   );

 

-/**

-  Lets the caller get one distinct application processor (AP) in the enabled processor pool to execite a 

-  caller-provided code stream while in SMM. 

-

-  @param  Procedure         A pointer to the code stream to be run on the designated AP of the system.

-  @param  CpuNumber         The zero-based index of the processor number of the AP on which the code stream is

-                            supposed to run. If the processor number points to the current processor or a disabled

-                            processor, then it will not run the supplied code.

-  @param  ProcArguments     Allows the caller to pass a list of parameters to the code that is run by

-                            the AP. It is an optional common mailbox between APs and the BSP to share information.

-

-  @retval EFI_SUCCESS           The call was successful and the return parameters are valid.

-  @retval EFI_INVALID_PARAMETER The input arguments are out of range.

-  @retval EFI_INVALID_PARAMETER The CPU requested is not available on this SMI invocation.

-  @retval EFI_INVALID_PARAMETER The CPU cannot support an additional service invocation.

-  

-  @note: Inconsistent with specification here:

-         In Framework Spec, this definition does not exist. This method is introduced in PI1.0 spec for 

-         implementation needs.

-         

-**/

-typedef

-EFI_STATUS

-(EFIAPI *EFI_SMM_STARTUP_THIS_AP)(

-  IN  FRAMEWORK_EFI_AP_PROCEDURE          Procedure,

-  IN  UINTN                               CpuNumber,

-  IN  OUT VOID                            *ProcArguments OPTIONAL

-  );

-

 ///

 /// The processor save-state information for IA-32 processors. This information is important in that the

 /// SMM drivers may need to ascertain the state of the processor before invoking the SMI.

diff --git a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
index 870622a63f..045e06dfb3 100644
--- a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
+++ b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
@@ -25,32 +25,16 @@
 #ifndef _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_

 #define _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_

 

+//

+// Share some common definitions with PI SMM

+//

+#include <Protocol/SmmAccess2.h>

+

 #define EFI_SMM_PEI_SMRAM_MEMORY_RESERVE \

   { \

     0x6dadf1d1, 0xd4cc, 0x4910, {0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d } \

   }

 

-///

-/// Describes the candidate regions for SMRAM that are

-/// supported by this platform.

-///

-typedef struct {

-  EFI_PHYSICAL_ADDRESS  PhysicalStart;  ///< Designates the physical address of the SMRAM in memory.

-  EFI_PHYSICAL_ADDRESS  CpuStart;       ///< Designates the address of the SMRAM, as seen by software executing on the processors. 

-  UINT64                PhysicalSize;   ///< Describes the number of bytes in the SMRAM region.

-  UINT64                RegionState;    ///< Describes the accessibility attributes of the SMRAM.

-} EFI_SMRAM_DESCRIPTOR;

-

-///

-/// Definition of SMRAM states, used as value for EFI_SMRAM_DESCRIPTOR.RegionState.

-///@{

-#define EFI_SMRAM_OPEN                0x00000001

-#define EFI_SMRAM_CLOSED              0x00000002

-#define EFI_SMRAM_LOCKED              0x00000004

-#define EFI_CACHEABLE                 0x00000008

-#define EFI_ALLOCATED                 0x00000010

-///@}

-

 /**

 * GUID specific data structure of HOB for reserving SMRAM regions.

 *

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmAccess.h b/IntelFrameworkPkg/Include/Protocol/SmmAccess.h
index da6386dbef..f6c904b02d 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmAccess.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmAccess.h
@@ -33,19 +33,6 @@ typedef struct _EFI_SMM_ACCESS_PROTOCOL  EFI_SMM_ACCESS_PROTOCOL;
   }

 

 //

-// SMM Access specification constant and types

-//

-// *******************************************************

-//  EFI_SMRAM_STATE

-// *******************************************************

-//

-#define EFI_SMRAM_OPEN    0x00000001

-#define EFI_SMRAM_CLOSED  0x00000002

-#define EFI_SMRAM_LOCKED  0x00000004

-#define EFI_CACHEABLE     0x00000008

-#define EFI_ALLOCATED     0x00000010

-

-//

 // SMM Access specification Member Function

 //

 /**

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
index 7c0ff89329..dd3ced55b7 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
@@ -24,6 +24,11 @@
 #define _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_

 

 //

+// Share some common definitions with PI SMM

+//

+#include <Protocol/SmmStandbyButtonDispatch2.h>

+

+//

 // Global ID for the Standby Button SMI Protocol

 //

 #define EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL_GUID \

@@ -37,16 +42,6 @@ typedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL  EFI_SMM_STANDBY_BUTTON
 // Related Definitions

 //

 

-///

-/// Standby Button. Example, Use for changing LEDs before ACPI OS is on.

-///    - DXE/BDS Phase

-///    - OS Install Phase

-///

-typedef enum {

-  EfiStandbyButtonEntry,

-  EfiStandbyButtonExit

-} EFI_STANDBY_BUTTON_PHASE;

-

 typedef struct {

   ///  Describes whether the child handler should be invoked upon the entry to the button

   ///  activation or upon exit (i.e., upon receipt of the button press event or upon release of

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
index 14d5a551b8..fd65f77b36 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
@@ -19,6 +19,10 @@
 #ifndef _EFI_SMM_SX_DISPATCH_H_

 #define _EFI_SMM_SX_DISPATCH_H_

 

+//

+// Share some common definitions with PI SMM

+//

+#include <Protocol/SmmSxDispatch2.h>

 

 //

 // Global ID for the Sx SMI Protocol

@@ -29,24 +33,6 @@
   }

 

 typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL  EFI_SMM_SX_DISPATCH_PROTOCOL;

-//

-// Related Definitions

-//

-typedef enum {

-  SxS0,

-  SxS1,

-  SxS2,

-  SxS3,

-  SxS4,

-  SxS5,

-  EfiMaximumSleepType

-} EFI_SLEEP_TYPE;

-

-typedef enum {

-  SxEntry,

-  SxExit,

-  EfiMaximumPhase

-} EFI_SLEEP_PHASE;

 

 typedef struct {

   EFI_SLEEP_TYPE  Type;

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
index 382461cb84..e72ce66687 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
@@ -19,6 +19,10 @@
 #ifndef _EFI_SMM_USB_DISPATCH_H_

 #define _EFI_SMM_USB_DISPATCH_H_

 

+//

+// Share some common definitions with PI SMM

+//

+#include <Protocol/SmmUsbDispatch2.h>

 

 //

 // Global ID for the USB Protocol

@@ -30,14 +34,6 @@
 

 typedef struct _EFI_SMM_USB_DISPATCH_PROTOCOL  EFI_SMM_USB_DISPATCH_PROTOCOL;

 

-//

-// Related Definitions

-//

-typedef enum {

-  UsbLegacy,

-  UsbWake

-} EFI_USB_SMI_TYPE;

-

 typedef struct {

   ///

   /// Describes whether this child handler will be invoked in response to a USB legacy