Add into MdePkg definitions for the EFI SMM Access2 Protocol as defined in the PI...

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

diff --git a/MdePkg/Include/Protocol/SmmAccess2.h b/MdePkg/Include/Protocol/SmmAccess2.h
new file mode 100644 (file)
index 0000000..17e884e
--- /dev/null
+++ b/MdePkg/Include/Protocol/SmmAccess2.h
@@ -0,0 +1,172 @@
+/** @file\r
+  EFI SMM Access2 Protocol as defined in the PI 1.2 specification.\r
+\r
+  This protocol is used to control the visibility of the SMRAM on the platform.\r
+  It abstracts the location and characteristics of SMRAM.  The expectation is\r
+  that the north bridge or memory controller would publish this protocol.\r
+\r
+  The principal functionality found in the memory controller includes the following: \r
+  - Exposing the SMRAM to all non-SMM agents, or the "open" state\r
+  - Shrouding the SMRAM to all but the SMM agents, or the "closed" state\r
+  - Preserving the system integrity, or "locking" the SMRAM, such that the settings cannot be \r
+    perturbed by either boot service or runtime agents \r
+\r
+  Copyright (c) 2009, 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
+  http://opensource.org/licenses/bsd-license.php                                            \r
+\r
+  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
+**/\r
+\r
+#ifndef _SMM_ACCESS2_H_\r
+#define _SMM_ACCESS2_H_\r
+\r
+#include <PiDxe.h>\r
+\r
+#define EFI_SMM_ACCESS2_PROTOCOL_GUID \\r
+  { \\r
+     0xc2702b74, 0x800c, 0x4131, {0x87, 0x46, 0x8f, 0xb5, 0xb8, 0x9c, 0xe4, 0xac } \\r
+  }\r
+\r
+///\r
+/// SMRAM states and capabilities\r
+///\r
+#define EFI_SMRAM_OPEN                  0x00000001\r
+#define EFI_SMRAM_CLOSED                0x00000002\r
+#define EFI_SMRAM_LOCKED                0x00000004\r
+#define EFI_CACHEABLE                   0x00000008\r
+#define EFI_ALLOCATED                   0x00000010\r
+#define EFI_NEEDS_TESTING               0x00000020\r
+#define EFI_NEEDS_ECC_INITIALIZATION    0x00000040\r
+\r
+///\r
+/// Structure describing a SMRAM region and its accessibility attributes\r
+///\r
+typedef struct {\r
+  ///\r
+  /// Designates the physical address of the SMRAM in memory. This view of memory is \r
+  /// the same as seen by I/O-based agents, for example, but it may not be the address seen \r
+  /// by the processors.\r
+  ///\r
+  EFI_PHYSICAL_ADDRESS  PhysicalStart;\r
+  ///\r
+  /// Designates the address of the SMRAM, as seen by software executing on the \r
+  /// processors. This address may or may not match PhysicalStart.\r
+  ///\r
+  EFI_PHYSICAL_ADDRESS  CpuStart;       \r
+  ///\r
+  /// Describes the number of bytes in the SMRAM region.\r
+  ///\r
+  UINT64                PhysicalSize;\r
+  ///\r
+  /// Describes the accessibility attributes of the SMRAM.  These attributes include the \r
+  /// hardware state (e.g., Open/Closed/Locked), capability (e.g., cacheable), logical \r
+  /// allocation (e.g., allocated), and pre-use initialization (e.g., needs testing/ECC \r
+  /// initialization).\r
+  ///\r
+  UINT64                RegionState;\r
+} EFI_SMRAM_DESCRIPTOR;\r
+\r
+typedef struct _EFI_SMM_ACCESS2_PROTOCOL  EFI_SMM_ACCESS2_PROTOCOL;\r
+\r
+/**\r
+  Opens the SMRAM area to be accessible by a boot-service driver.\r
+\r
+  This function "opens" SMRAM so that it is visible while not inside of SMM. The function should \r
+  return EFI_UNSUPPORTED if the hardware does not support hiding of SMRAM. The function \r
+  should return EFI_DEVICE_ERROR if the SMRAM configuration is locked.\r
+\r
+  @param[in] This           The EFI_SMM_ACCESS2_PROTOCOL instance.\r
+\r
+  @retval EFI_SUCCESS       The operation was successful.\r
+  @retval EFI_UNSUPPORTED   The system does not support opening and closing of SMRAM.\r
+  @retval EFI_DEVICE_ERROR  SMRAM cannot be opened, perhaps because it is locked.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMM_OPEN)(\r
+  IN CONST EFI_SMM_ACCESS2_PROTOCOL  *This\r
+  );\r
+\r
+/**\r
+  Inhibits access to the SMRAM.\r
+\r
+  This function "closes" SMRAM so that it is not visible while outside of SMM. The function should \r
+  return EFI_UNSUPPORTED if the hardware does not support hiding of SMRAM.\r
+\r
+  @param[in] This           The EFI_SMM_ACCESS2_PROTOCOL instance.\r
+\r
+  @retval EFI_SUCCESS       The operation was successful.\r
+  @retval EFI_UNSUPPORTED   The system does not support opening and closing of SMRAM.\r
+  @retval EFI_DEVICE_ERROR  SMRAM cannot be closed.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMM_CLOSE)(\r
+  IN CONST EFI_SMM_ACCESS2_PROTOCOL  *This\r
+  );\r
+\r
+/**\r
+  Inhibits access to the SMRAM.\r
+\r
+  This function prohibits access to the SMRAM region.  This function is usually implemented such \r
+  that it is a write-once operation. \r
+\r
+  @param[in] This          The EFI_SMM_ACCESS2_PROTOCOL instance.\r
+\r
+  @retval EFI_SUCCESS      The device was successfully locked.\r
+  @retval EFI_UNSUPPORTED  The system does not support locking of SMRAM.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMM_LOCK)(\r
+  IN CONST EFI_SMM_ACCESS2_PROTOCOL  *This\r
+  );\r
+\r
+/**\r
+  Queries the memory controller for the possible regions that will support SMRAM.\r
+\r
+  @param[in]     This           The EFI_SMM_ACCESS2_PROTOCOL instance.\r
+  @param[in,out] SmramMapSize   A pointer to the size, in bytes, of the SmramMemoryMap buffer.\r
+  @param[in,out] SmramMap       A pointer to the buffer in which firmware places the current memory map.\r
+\r
+  @retval EFI_SUCCESS           The chipset supported the given resource.\r
+  @retval EFI_BUFFER_TOO_SMALL  The SmramMap parameter was too small.  The current buffer size \r
+                                needed to hold the memory map is returned in SmramMapSize.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMM_CAPABILITIES)(\r
+  IN CONST EFI_SMM_ACCESS2_PROTOCOL  *This,\r
+  IN OUT UINTN                       *SmramMapSize,\r
+  IN OUT EFI_SMRAM_DESCRIPTOR        *SmramMap\r
+  );\r
+\r
+///\r
+///  EFI SMM Access2 Protocol is used to control the visibility of the SMRAM on the platform.\r
+///  It abstracts the location and characteristics of SMRAM.  The expectation is\r
+///  that the north bridge or memory controller would publish this protocol.\r
+/// \r
+struct _EFI_SMM_ACCESS2_PROTOCOL {\r
+  EFI_SMM_OPEN          Open;\r
+  EFI_SMM_CLOSE         Close;\r
+  EFI_SMM_LOCK          Lock;\r
+  EFI_SMM_CAPABILITIES  GetCapabilities;\r
+  ///\r
+  /// Indicates the current state of the SMRAM. Set to TRUE if SMRAM is locked.\r
+  ///\r
+  BOOLEAN               LockState;\r
+  ///\r
+  /// Indicates the current state of the SMRAM. Set to TRUE if SMRAM is open.\r
+  ///\r
+  BOOLEAN               OpenState;\r
+};\r
+\r
+extern EFI_GUID gEfiSmmAccess2ProtocolGuid;\r
+\r
+#endif\r
+\r

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index a0c8c6823001b6a035b4eb3d179ffe3515087055..a5ecb472089e9ea138b8bf3d7c8687a9daaec2ca 100644 (file)
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -581,6 +581,9 @@
   ## Include/Protocol/SmmBase2.h\r
   gEfiSmmBase2ProtocolGuid        = { 0xf4ccbfb7, 0xf6e0, 0x47fd, {0x9d, 0xd4, 0x10, 0xa8, 0xf1, 0x50, 0xc1, 0x91 }}\r
 \r
+  ## Include/Protocol/SmmAccess2.h\r
+  gEfiSmmAccess2ProtocolGuid      = { 0xc2702b74, 0x800c, 0x4131, {0x87, 0x46, 0x8f, 0xb5, 0xb8, 0x9c, 0xe4, 0xac }}\r
+\r
   #\r
   # Protocols defined in UEFI2.1/UEFI2.0/EFI1.1\r
   #\r