IntelFrameworkPkg/Include/Protocol/SmmAccess.h File Reference


Data Structures

struct  _EFI_SMM_ACCESS_PROTOCOL

Defines

#define EFI_SMM_ACCESS_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_SMM_ACCESS_PROTOCOL 
EFI_SMM_ACCESS_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_SMM_OPEN )(IN EFI_SMM_ACCESS_PROTOCOL *This, UINTN DescriptorIndex)
typedef EFI_STATUS(EFIAPI * EFI_SMM_CLOSE )(IN EFI_SMM_ACCESS_PROTOCOL *This, UINTN DescriptorIndex)
typedef EFI_STATUS(EFIAPI * EFI_SMM_LOCK )(IN EFI_SMM_ACCESS_PROTOCOL *This, UINTN DescriptorIndex)
typedef EFI_STATUS(EFIAPI * EFI_SMM_CAPABILITIES )(IN EFI_SMM_ACCESS_PROTOCOL *This, IN OUT UINTN *SmramMapSize, IN OUT EFI_SMRAM_DESCRIPTOR *SmramMap)

Variables

EFI_GUID gEfiSmmAccessProtocolGuid

Detailed Description

This file declares the SMM SMRAM Access abstraction protocol, which is used to control the visibility of the SMRAM on the platform. The expectation is that the north bridge or memory controller would publish this protocol. For example, the Memory Controller Hub (MCH) has the hardware provision for this type of control. Because of the protected, distinguished class of memory for IA-32 systems, the expectation is that this protocol would be supported only on IA-32 systems.

Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This Protocol is defined in Framework of EFI SMM Core Interface Spec Version 0.9.

Define Documentation

#define EFI_SMM_ACCESS_PROTOCOL_GUID

Value:

{ \
    0x3792095a, 0xe309, 0x4c1e, {0xaa, 0x01, 0x85, 0xf5, 0x65, 0x5a, 0x17, 0xf1 } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_SMM_CAPABILITIES)(IN EFI_SMM_ACCESS_PROTOCOL *This, IN OUT UINTN *SmramMapSize, IN OUT EFI_SMRAM_DESCRIPTOR *SmramMap)

Queries the memory controller for the possible regions that will support SMRAM.

Parameters:
This The EFI_SMM_ACCESS_PROTOCOL instance.
SmramMapSize A pointer to the size, in bytes, of the SmramMemoryMap buffer.
SmramMap A pointer to the buffer in which firmware places the current memory map.
Return values:
EFI_SUCCESS The chipset supported the given resource.
EFI_BUFFER_TOO_SMALL The SmramMap parameter was too small.

typedef EFI_STATUS(EFIAPI * EFI_SMM_CLOSE)(IN EFI_SMM_ACCESS_PROTOCOL *This, UINTN DescriptorIndex)

Inhibits access to the SMRAM.

Parameters:
This The EFI_SMM_ACCESS_PROTOCOL instance.
DescriptorIndex Indicates that the driver wishes to close the memory tagged by this index.
Return values:
EFI_SUCCESS The operation was successful.
EFI_DEVICE_ERROR The given DescriptorIndex is not open.
EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.
EFI_NOT_STARTED The SMM base service has not been initialized.

typedef EFI_STATUS(EFIAPI * EFI_SMM_LOCK)(IN EFI_SMM_ACCESS_PROTOCOL *This, UINTN DescriptorIndex)

Inhibits access to the SMRAM.

Parameters:
This The EFI_SMM_ACCESS_PROTOCOL instance.
DescriptorIndex Indicates that the driver wishes to lock the memory tagged by this index.
Return values:
EFI_SUCCESS The operation was successful.
EFI_DEVICE_ERROR The given DescriptorIndex is not open.
EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.
EFI_NOT_STARTED The SMM base service has not been initialized.

typedef EFI_STATUS(EFIAPI * EFI_SMM_OPEN)(IN EFI_SMM_ACCESS_PROTOCOL *This, UINTN DescriptorIndex)

Opens the SMRAM area to be accessible by a boot-service driver.

Parameters:
This The EFI_SMM_ACCESS_PROTOCOL instance.
DescriptorIndex Indicates that the driver wishes to open the memory tagged by this index.
Return values:
EFI_SUCCESS The operation was successful.
EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.
EFI_NOT_STARTED The SMM base service has not been initialized.


Variable Documentation


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1