2 Variable check definitions.
4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef _VARIABLE_CHECK_H_
10 #define _VARIABLE_CHECK_H_
12 #include <Uefi/UefiSpec.h>
14 typedef struct _EDKII_VAR_CHECK_PROTOCOL EDKII_VAR_CHECK_PROTOCOL
;
16 #define EDKII_VAR_CHECK_PROTOCOL_GUID { \
17 0xaf23b340, 0x97b4, 0x4685, { 0x8d, 0x4f, 0xa3, 0xf2, 0x81, 0x69, 0xb2, 0x1d } \
20 typedef EFI_SET_VARIABLE VAR_CHECK_SET_VARIABLE_CHECK_HANDLER
;
23 Register SetVariable check handler.
24 Variable driver will call the handler to do check before
25 really setting the variable into variable storage.
27 @param[in] Handler Pointer to the check handler.
29 @retval EFI_SUCCESS The SetVariable check handler was registered successfully.
30 @retval EFI_INVALID_PARAMETER Handler is NULL.
31 @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has already been signaled.
32 @retval EFI_OUT_OF_RESOURCES There is not enough resource for the SetVariable check handler register request.
33 @retval EFI_UNSUPPORTED This interface is not implemented.
34 For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.
39 (EFIAPI
* EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER
) (
40 IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER Handler
43 #define VAR_CHECK_VARIABLE_PROPERTY_REVISION 0x0001
45 // 1. Set by VariableLock PROTOCOL
46 // 2. Set by VarCheck PROTOCOL
48 // If set, other fields for check will be ignored.
50 #define VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY BIT0
58 } VAR_CHECK_VARIABLE_PROPERTY
;
63 VAR_CHECK_VARIABLE_PROPERTY VariableProperty
;
64 } VARIABLE_ENTRY_PROPERTY
;
67 Variable property set.
68 Variable driver will do check according to the VariableProperty before
69 really setting the variable into variable storage.
71 @param[in] Name Pointer to the variable name.
72 @param[in] Guid Pointer to the vendor GUID.
73 @param[in] VariableProperty Pointer to the input variable property.
75 @retval EFI_SUCCESS The property of variable specified by the Name and Guid was set successfully.
76 @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string,
77 or the fields of VariableProperty are not valid.
78 @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has
79 already been signaled.
80 @retval EFI_OUT_OF_RESOURCES There is not enough resource for the variable property set request.
85 (EFIAPI
* EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET
) (
88 IN VAR_CHECK_VARIABLE_PROPERTY
*VariableProperty
92 Variable property get.
94 @param[in] Name Pointer to the variable name.
95 @param[in] Guid Pointer to the vendor GUID.
96 @param[out] VariableProperty Pointer to the output variable property.
98 @retval EFI_SUCCESS The property of variable specified by the Name and Guid was got successfully.
99 @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string.
100 @retval EFI_NOT_FOUND The property of variable specified by the Name and Guid was not found.
105 (EFIAPI
* EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET
) (
108 OUT VAR_CHECK_VARIABLE_PROPERTY
*VariableProperty
111 struct _EDKII_VAR_CHECK_PROTOCOL
{
112 EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER RegisterSetVariableCheckHandler
;
113 EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET VariablePropertySet
;
114 EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET VariablePropertyGet
;
117 extern EFI_GUID gEdkiiVarCheckProtocolGuid
;