Add more comments for IntelFramework's header files.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmAccess.h b/IntelFrameworkPkg/Include/Protocol/SmmAccess.h
index 700eb250068357bdc0a879005dbb062a2a79936f..231247c0df0e4cdbc41a5aaafd9b4efd5e6a91fc 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmAccess.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmAccess.h
@@ -1,5 +1,10 @@
 /** @file\r
-  This file declares SMM SMRAM Access abstraction protocol\r
+  This file declares 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
   All rights reserved. This program and the accompanying materials\r
@@ -10,8 +15,6 @@
   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
-  Module Name:  SmmAccess.h\r
-\r
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
   Version 0.9.\r
@@ -20,7 +23,8 @@
 #ifndef _SMM_ACCESS_H_\r
 #define _SMM_ACCESS_H_\r
 \r
-#include <SmramMemoryReserve.h>\r
+#include <PiDxe.h>\r
+#include <Guid/SmramMemoryReserve.h>\r
 \r
 typedef struct _EFI_SMM_ACCESS_PROTOCOL  EFI_SMM_ACCESS_PROTOCOL;\r
 \r