]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SmmAccess2.h
MdePkg/Include/Protocol/Tls.h: pack structures from the TLS RFC
[mirror_edk2.git] / MdePkg / Include / Protocol / SmmAccess2.h
index 5904266ba0bec275dac5d3657e500bc551e95a11..3dc15fe597af35f1c73e6fa689e3d044c3551b86 100644 (file)
 #ifndef _SMM_ACCESS2_H_\r
 #define _SMM_ACCESS2_H_\r
 \r
-#define EFI_SMM_ACCESS2_PROTOCOL_GUID \\r
-  { \\r
-     0xc2702b74, 0x800c, 0x4131, {0x87, 0x46, 0x8f, 0xb5, 0xb8, 0x9c, 0xe4, 0xac } \\r
-  }\r
+#include <Protocol/MmAccess.h>\r
 \r
+#define EFI_SMM_ACCESS2_PROTOCOL_GUID       EFI_MM_ACCESS_PROTOCOL_GUID\r
 \r
-typedef struct _EFI_SMM_ACCESS2_PROTOCOL  EFI_SMM_ACCESS2_PROTOCOL;\r
+typedef EFI_MM_ACCESS_PROTOCOL  EFI_SMM_ACCESS2_PROTOCOL;\r
 \r
-/**\r
-  Opens the SMRAM area to be accessible by a boot-service driver.\r
+typedef EFI_MM_OPEN EFI_SMM_OPEN2;\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
+typedef EFI_MM_CLOSE EFI_SMM_CLOSE2;\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_OPEN2)(\r
-  IN 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_CLOSE2)(\r
-  IN 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_LOCK2)(\r
-  IN 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_CAPABILITIES2)(\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 platform should report all \r
-///  MMRAM via EFI_MM_ACCESS_PROTOCOL. The expectation is that the north bridge or memory \r
-///  controller would publish this protocol.\r
-/// \r
-struct _EFI_SMM_ACCESS2_PROTOCOL {\r
-  EFI_SMM_OPEN2          Open;\r
-  EFI_SMM_CLOSE2         Close;\r
-  EFI_SMM_LOCK2          Lock;\r
-  EFI_SMM_CAPABILITIES2  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
+typedef EFI_MM_LOCK EFI_SMM_LOCK2;\r
 \r
+typedef EFI_MM_CAPABILITIES EFI_SMM_CAPABILITIES2;\r
 extern EFI_GUID gEfiSmmAccess2ProtocolGuid;\r
 \r
 #endif\r