/** @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
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
#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
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_OPEN) (\r
+(EFIAPI *EFI_SMM_OPEN)(\r
IN EFI_SMM_ACCESS_PROTOCOL *This,\r
UINTN DescriptorIndex\r
);\r
Inhibits access to the SMRAM.\r
\r
@param This The EFI_SMM_ACCESS_PROTOCOL instance.\r
- @param DescriptorIndex Indicates that the driver wishes to open\r
+ @param DescriptorIndex Indicates that the driver wishes to close\r
the memory tagged by this index.\r
\r
@retval EFI_SUCCESS The operation was successful.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_CLOSE) (\r
+(EFIAPI *EFI_SMM_CLOSE)(\r
IN EFI_SMM_ACCESS_PROTOCOL *This,\r
UINTN DescriptorIndex\r
);\r
\r
/**\r
Inhibits access to the SMRAM.\r
+\r
@param This The EFI_SMM_ACCESS_PROTOCOL instance.\r
- @param DescriptorIndex Indicates that the driver wishes to open\r
+ @param DescriptorIndex Indicates that the driver wishes to lock\r
the memory tagged by this index.\r
\r
@retval EFI_SUCCESS The operation was successful.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_LOCK) (\r
+(EFIAPI *EFI_SMM_LOCK)(\r
IN EFI_SMM_ACCESS_PROTOCOL *This,\r
UINTN DescriptorIndex\r
);\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_CAPABILITIES) (\r
+(EFIAPI *EFI_SMM_CAPABILITIES)(\r
IN EFI_SMM_ACCESS_PROTOCOL *This,\r
IN OUT UINTN *SmramMapSize,\r
IN OUT EFI_SMRAM_DESCRIPTOR *SmramMap\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
+ 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
+ Indicates the current state of the SMRAM. Set to TRUE if any region is open.\r
\r
**/\r
struct _EFI_SMM_ACCESS_PROTOCOL {\r