Committing changes to the comments, after review with engineers.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmAccess.h

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmAccess.h b/IntelFrameworkPkg/Include/Protocol/SmmAccess.h
index d7719e44c1c66a526b32a12551c042af829588f7..da6386dbefdbe35d238ef506152a562cd1fc0076 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmAccess.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmAccess.h
@@ -1,12 +1,12 @@
 /** @file\r
-  This file declares SMM SMRAM Access abstraction protocol which is used to control \r
+  This file declares the SMM SMRAM Access abstraction protocol, which is used to control \r
   the visibility of the SMRAM on the platform. The expectation is\r
   that the north bridge or memory controller would publish this protocol. \r
   For example, the Memory Controller Hub (MCH) has the hardware provision for this \r
   type of control. Because of the protected, distinguished class of memory for IA-32 \r
   systems, the expectation is that this protocol would be supported only on IA-32 systems.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 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
@@ -23,7 +23,6 @@
 #ifndef _SMM_ACCESS_H_\r
 #define _SMM_ACCESS_H_\r
 \r
-#include <PiDxe.h>\r
 #include <Guid/SmramMemoryReserve.h>\r
 \r
 typedef struct _EFI_SMM_ACCESS_PROTOCOL  EFI_SMM_ACCESS_PROTOCOL;\r
@@ -128,35 +127,15 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   This protocol is used to control the visibility of the SMRAM on the platform.\r
-\r
-  @param Open\r
-  Opens the SMRAM.\r
-\r
-  @param Close\r
-  Closes the SMRAM.\r
-\r
-  @param Lock\r
-  Locks the SMRAM.\r
-\r
-  @param GetCapabilities\r
-  Gets information on possible SMRAM regions.\r
-\r
-  @param LockState\r
-  Indicates the current state of the SMRAM. Set to TRUE if any region is locked.\r
-\r
-  @param OpenState\r
-  Indicates the current state of the SMRAM. Set to TRUE if any region is open.\r
-\r
 **/\r
 struct _EFI_SMM_ACCESS_PROTOCOL {\r
-  EFI_SMM_OPEN          Open;\r
-  EFI_SMM_CLOSE         Close;\r
-  EFI_SMM_LOCK          Lock;\r
-  EFI_SMM_CAPABILITIES  GetCapabilities;\r
-  BOOLEAN               LockState;\r
-  BOOLEAN               OpenState;\r
+  EFI_SMM_OPEN          Open;             ///< Opens the SMRAM.\r
+  EFI_SMM_CLOSE         Close;            ///< Closes the SMRAM.\r
+  EFI_SMM_LOCK          Lock;             ///< Locks the SMRAM.\r
+  EFI_SMM_CAPABILITIES  GetCapabilities;  ///< Gets information on possible SMRAM regions.\r
+  BOOLEAN               LockState;        ///< Indicates the current state of the SMRAM. Set to TRUE if any region is locked.\r
+  BOOLEAN               OpenState;        ///< Indicates the current state of the SMRAM. Set to TRUE if any region is open.\r
 };\r
 \r
 extern EFI_GUID gEfiSmmAccessProtocolGuid;\r