VarCheck.h File Reference

#include <Uefi/UefiSpec.h>

Go to the source code of this file.

Data Structures
struct	VAR_CHECK_VARIABLE_PROPERTY
struct	VARIABLE_ENTRY_PROPERTY
struct	_EDKII_VAR_CHECK_PROTOCOL

Macros
#define	EDKII_VAR_CHECK_PROTOCOL_GUID
#define	VAR_CHECK_VARIABLE_PROPERTY_REVISION   0x0001
#define	VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY   BIT0

Typedefs
typedef struct _EDKII_VAR_CHECK_PROTOCOL	EDKII_VAR_CHECK_PROTOCOL
typedef EFI_SET_VARIABLE	VAR_CHECK_SET_VARIABLE_CHECK_HANDLER
typedef EFI_STATUS(EFIAPI *	EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER) (IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER Handler)
typedef EFI_STATUS(EFIAPI *	EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET) (IN CHAR16 *Name, IN EFI_GUID *Guid, IN VAR_CHECK_VARIABLE_PROPERTY *VariableProperty)
typedef EFI_STATUS(EFIAPI *	EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET) (IN CHAR16 *Name, IN EFI_GUID *Guid, OUT VAR_CHECK_VARIABLE_PROPERTY *VariableProperty)

Variables
EFI_GUID	gEdkiiVarCheckProtocolGuid

Detailed Description

Variable check definitions.

Copyright (c) 2015, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file VarCheck.h.

Macro Definition Documentation

EDKII_VAR_CHECK_PROTOCOL_GUID

#define EDKII_VAR_CHECK_PROTOCOL_GUID

Value:

  {\
  0xaf23b340, 0x97b4, 0x4685, { 0x8d, 0x4f, 0xa3, 0xf2, 0x81, 0x69, 0xb2, 0x1d } \
};

Definition at line 16 of file VarCheck.h.

VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY

#define VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY   BIT0

Definition at line 50 of file VarCheck.h.

VAR_CHECK_VARIABLE_PROPERTY_REVISION

#define VAR_CHECK_VARIABLE_PROPERTY_REVISION   0x0001

Definition at line 43 of file VarCheck.h.

Typedef Documentation

EDKII_VAR_CHECK_PROTOCOL

typedef struct _EDKII_VAR_CHECK_PROTOCOL EDKII_VAR_CHECK_PROTOCOL

Definition at line 14 of file VarCheck.h.

EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER

typedef EFI_STATUS(EFIAPI * EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER) (IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER Handler)

Register SetVariable check handler. Variable driver will call the handler to do check before really setting the variable into variable storage.

Parameters

[in]

Handler

Pointer to the check handler.

Return values

EFI_SUCCESS	The SetVariable check handler was registered successfully.
EFI_INVALID_PARAMETER	Handler is NULL.
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 for the SetVariable check handler register request.
EFI_UNSUPPORTED	This interface is not implemented. For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.

Definition at line 38 of file VarCheck.h.

EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET

typedef EFI_STATUS(EFIAPI * EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET) (IN CHAR16 *Name, IN EFI_GUID *Guid, OUT VAR_CHECK_VARIABLE_PROPERTY *VariableProperty)

Variable property get.

Parameters

[in]	Name	Pointer to the variable name.
[in]	Guid	Pointer to the vendor GUID.
[out]	VariableProperty	Pointer to the output variable property.

Return values

EFI_SUCCESS	The property of variable specified by the Name and Guid was got successfully.
EFI_INVALID_PARAMETER	Name, Guid or VariableProperty is NULL, or Name is an empty string.
EFI_NOT_FOUND	The property of variable specified by the Name and Guid was not found.

Definition at line 104 of file VarCheck.h.

EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET

typedef EFI_STATUS(EFIAPI * EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET) (IN CHAR16 *Name, IN EFI_GUID *Guid, IN VAR_CHECK_VARIABLE_PROPERTY *VariableProperty)

Variable property set. Variable driver will do check according to the VariableProperty before really setting the variable into variable storage.

Parameters

[in]	Name	Pointer to the variable name.
[in]	Guid	Pointer to the vendor GUID.
[in]	VariableProperty	Pointer to the input variable property.

Return values

EFI_SUCCESS	The property of variable specified by the Name and Guid was set successfully.
EFI_INVALID_PARAMETER	Name, Guid or VariableProperty is NULL, or Name is an empty string, or the fields of VariableProperty are not valid.
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 for the variable property set request.

Definition at line 84 of file VarCheck.h.

VAR_CHECK_SET_VARIABLE_CHECK_HANDLER

typedef EFI_SET_VARIABLE VAR_CHECK_SET_VARIABLE_CHECK_HANDLER

Definition at line 20 of file VarCheck.h.