MdePkg/Include/Protocol/SmmAccess2.h File Reference


Data Structures

struct  _EFI_SMM_ACCESS2_PROTOCOL

Defines

#define EFI_SMM_ACCESS2_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_SMM_ACCESS2_PROTOCOL 
EFI_SMM_ACCESS2_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_SMM_OPEN2 )(IN EFI_SMM_ACCESS2_PROTOCOL *This)
typedef EFI_STATUS(EFIAPI * EFI_SMM_CLOSE2 )(IN EFI_SMM_ACCESS2_PROTOCOL *This)
typedef EFI_STATUS(EFIAPI * EFI_SMM_LOCK2 )(IN EFI_SMM_ACCESS2_PROTOCOL *This)
typedef EFI_STATUS(EFIAPI * EFI_SMM_CAPABILITIES2 )(IN CONST EFI_SMM_ACCESS2_PROTOCOL *This, IN OUT UINTN *SmramMapSize, IN OUT EFI_SMRAM_DESCRIPTOR *SmramMap)

Variables

EFI_GUID gEfiSmmAccess2ProtocolGuid

Detailed Description

EFI SMM Access2 Protocol as defined in the PI 1.2 specification.

This protocol is used to control the visibility of the SMRAM on the platform. It abstracts the location and characteristics of SMRAM. The expectation is that the north bridge or memory controller would publish this protocol.

The principal functionality found in the memory controller includes the following:

Copyright (c) 2009 - 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 which 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.


Define Documentation

#define EFI_SMM_ACCESS2_PROTOCOL_GUID

Value:

{ \
     0xc2702b74, 0x800c, 0x4131, {0x87, 0x46, 0x8f, 0xb5, 0xb8, 0x9c, 0xe4, 0xac } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_SMM_CAPABILITIES2)(IN CONST EFI_SMM_ACCESS2_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:
[in] This The EFI_SMM_ACCESS2_PROTOCOL instance.
[in,out] SmramMapSize A pointer to the size, in bytes, of the SmramMemoryMap buffer.
[in,out] 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. The current buffer size needed to hold the memory map is returned in SmramMapSize.

typedef EFI_STATUS(EFIAPI * EFI_SMM_CLOSE2)(IN EFI_SMM_ACCESS2_PROTOCOL *This)

Inhibits access to the SMRAM.

This function "closes" SMRAM so that it is not visible while outside of SMM. The function should return EFI_UNSUPPORTED if the hardware does not support hiding of SMRAM.

Parameters:
[in] This The EFI_SMM_ACCESS2_PROTOCOL instance.
Return values:
EFI_SUCCESS The operation was successful.
EFI_UNSUPPORTED The system does not support opening and closing of SMRAM.
EFI_DEVICE_ERROR SMRAM cannot be closed.

typedef EFI_STATUS(EFIAPI * EFI_SMM_LOCK2)(IN EFI_SMM_ACCESS2_PROTOCOL *This)

Inhibits access to the SMRAM.

This function prohibits access to the SMRAM region. This function is usually implemented such that it is a write-once operation.

Parameters:
[in] This The EFI_SMM_ACCESS2_PROTOCOL instance.
Return values:
EFI_SUCCESS The device was successfully locked.
EFI_UNSUPPORTED The system does not support locking of SMRAM.

typedef EFI_STATUS(EFIAPI * EFI_SMM_OPEN2)(IN EFI_SMM_ACCESS2_PROTOCOL *This)

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

This function "opens" SMRAM so that it is visible while not inside of SMM. The function should return EFI_UNSUPPORTED if the hardware does not support hiding of SMRAM. The function should return EFI_DEVICE_ERROR if the SMRAM configuration is locked.

Parameters:
[in] This The EFI_SMM_ACCESS2_PROTOCOL instance.
Return values:
EFI_SUCCESS The operation was successful.
EFI_UNSUPPORTED The system does not support opening and closing of SMRAM.
EFI_DEVICE_ERROR SMRAM cannot be opened, perhaps because it is locked.


Variable Documentation


Generated on Wed Sep 23 16:24:23 2015 for MdePkg[ALL] by  doxygen 1.5.7.1