MdeModulePkg/Include/Protocol/VariableLock.h File Reference


Data Structures

struct  _EDKII_VARIABLE_LOCK_PROTOCOL

Defines

#define EDKII_VARIABLE_LOCK_PROTOCOL_GUID

Typedefs

typedef struct
_EDKII_VARIABLE_LOCK_PROTOCOL 
EDKII_VARIABLE_LOCK_PROTOCOL
typedef IN CHAR16 * VariableName
typedef IN CHAR16 IN EFI_GUID * VendorGuid

Functions

typedef EFI_STATUS (EFIAPI *EDKII_VARIABLE_LOCK_PROTOCOL_REQUEST_TO_LOCK)(IN CONST EDKII_VARIABLE_LOCK_PROTOCOL *This

Variables

EFI_GUID gEdkiiVariableLockProtocolGuid

Detailed Description

Variable Lock Protocol is related to EDK II-specific implementation of variables and intended for use as a means to mark a variable read-only after the event EFI_END_OF_DXE_EVENT_GUID is signaled.

Copyright (c) 2013, 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 EDKII_VARIABLE_LOCK_PROTOCOL_GUID

Value:

{ \
    0xcd3d0a05, 0x9e24, 0x437c, { 0xa8, 0x91, 0x1e, 0xe0, 0x53, 0xdb, 0x76, 0x38 } \
  }


Typedef Documentation

typedef IN CHAR16* VariableName

typedef IN CHAR16 IN EFI_GUID* VendorGuid


Function Documentation

typedef EFI_STATUS ( EFIAPI *  EDKII_VARIABLE_LOCK_PROTOCOL_REQUEST_TO_LOCK  ) 

Mark a variable that will become read-only after leaving the DXE phase of execution. Write request coming from SMM environment through EFI_SMM_VARIABLE_PROTOCOL is allowed.

Parameters:
[in] This The EDKII_VARIABLE_LOCK_PROTOCOL instance.
[in] VariableName A pointer to the variable name that will be made read-only subsequently.
[in] VendorGuid A pointer to the vendor GUID that will be made read-only subsequently.
Return values:
EFI_SUCCESS The variable specified by the VariableName and the VendorGuid was marked as pending to be read-only.
EFI_INVALID_PARAMETER VariableName or VendorGuid is NULL. Or VariableName is an empty string.
EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has already been signaled.
EFI_OUT_OF_RESOURCES There is not enough resource to hold the lock request.


Variable Documentation


Generated on Thu Sep 24 23:30:15 2015 for MdeModulePkg[ALL] by  doxygen 1.5.7.1