--- /dev/null
+/** @file\r
+ Provides variable check services and database management.\r
+\r
+Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef _VARIABLE_CHECK_LIB_H_\r
+#define _VARIABLE_CHECK_LIB_H_\r
+\r
+#include <Protocol/VarCheck.h>\r
+\r
+typedef enum {\r
+ VarCheckRequestReserved0 = 0,\r
+ VarCheckRequestReserved1 = 1,\r
+ VarCheckFromTrusted = 2,\r
+ VarCheckFromUntrusted = 3,\r
+} VAR_CHECK_REQUEST_SOURCE;\r
+\r
+typedef\r
+VOID\r
+(EFIAPI *VAR_CHECK_END_OF_DXE_CALLBACK) (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Register END_OF_DXE callback.\r
+ The callback will be invoked by VarCheckLibInitializeAtEndOfDxe().\r
+\r
+ @param[in] Callback END_OF_DXE callback.\r
+\r
+ @retval EFI_SUCCESS The callback was registered successfully.\r
+ @retval EFI_INVALID_PARAMETER Callback is NULL.\r
+ @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+ already been signaled.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough resource for the callback register request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibRegisterEndOfDxeCallback (\r
+ IN VAR_CHECK_END_OF_DXE_CALLBACK Callback\r
+ );\r
+\r
+/**\r
+ Var check initialize at END_OF_DXE.\r
+\r
+ This function needs to be called at END_OF_DXE.\r
+ Address pointers may be returned,\r
+ and caller needs to ConvertPointer() for the pointers.\r
+\r
+ @param[in, out] AddressPointerCount Output pointer to address pointer count.\r
+\r
+ @return Address pointer buffer, NULL if input AddressPointerCount is NULL.\r
+\r
+**/\r
+VOID ***\r
+EFIAPI\r
+VarCheckLibInitializeAtEndOfDxe (\r
+ IN OUT UINTN *AddressPointerCount OPTIONAL\r
+ );\r
+\r
+/**\r
+ Register address pointer.\r
+ The AddressPointer may be returned by VarCheckLibInitializeAtEndOfDxe().\r
+\r
+ @param[in] AddressPointer Address pointer.\r
+\r
+ @retval EFI_SUCCESS The address pointer was registered successfully.\r
+ @retval EFI_INVALID_PARAMETER AddressPointer is NULL.\r
+ @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+ already been signaled.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough resource for the address pointer register request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibRegisterAddressPointer (\r
+ IN VOID **AddressPointer\r
+ );\r
+\r
+/**\r
+ Register SetVariable check handler.\r
+\r
+ @param[in] Handler Pointer to check handler.\r
+\r
+ @retval EFI_SUCCESS The SetVariable check handler was registered successfully.\r
+ @retval EFI_INVALID_PARAMETER Handler is NULL.\r
+ @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+ already been signaled.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough resource for the SetVariable check handler register request.\r
+ @retval EFI_UNSUPPORTED This interface is not implemented.\r
+ For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibRegisterSetVariableCheckHandler (\r
+ IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER Handler\r
+ );\r
+\r
+/**\r
+ Variable property set.\r
+\r
+ @param[in] Name Pointer to the variable name.\r
+ @param[in] Guid Pointer to the vendor GUID.\r
+ @param[in] VariableProperty Pointer to the input variable property.\r
+\r
+ @retval EFI_SUCCESS The property of variable specified by the Name and Guid was set successfully.\r
+ @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string,\r
+ or the fields of VariableProperty are not valid.\r
+ @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+ already been signaled.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough resource for the variable property set request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibVariablePropertySet (\r
+ IN CHAR16 *Name,\r
+ IN EFI_GUID *Guid,\r
+ IN VAR_CHECK_VARIABLE_PROPERTY *VariableProperty\r
+ );\r
+\r
+/**\r
+ Variable property get.\r
+\r
+ @param[in] Name Pointer to the variable name.\r
+ @param[in] Guid Pointer to the vendor GUID.\r
+ @param[out] VariableProperty Pointer to the output variable property.\r
+\r
+ @retval EFI_SUCCESS The property of variable specified by the Name and Guid was got successfully.\r
+ @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string.\r
+ @retval EFI_NOT_FOUND The property of variable specified by the Name and Guid was not found.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibVariablePropertyGet (\r
+ IN CHAR16 *Name,\r
+ IN EFI_GUID *Guid,\r
+ OUT VAR_CHECK_VARIABLE_PROPERTY *VariableProperty\r
+ );\r
+\r
+/**\r
+ SetVariable check.\r
+\r
+ @param[in] VariableName Name of Variable to set.\r
+ @param[in] VendorGuid Variable vendor GUID.\r
+ @param[in] Attributes Attribute value of the variable.\r
+ @param[in] DataSize Size of Data to set.\r
+ @param[in] Data Data pointer.\r
+ @param[in] RequestSource Request source.\r
+\r
+ @retval EFI_SUCCESS The SetVariable check result was success.\r
+ @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, GUID,\r
+ DataSize and Data value was supplied.\r
+ @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r
+ @retval Others The other return status from check handler.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibSetVariableCheck (\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID *VendorGuid,\r
+ IN UINT32 Attributes,\r
+ IN UINTN DataSize,\r
+ IN VOID *Data,\r
+ IN VAR_CHECK_REQUEST_SOURCE RequestSource\r
+ );\r
+\r
+#endif\r
projects / mirror_edk2.git / blobdiff