MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / VarCheck.h

/** @file\r
  Variable check definitions.\r
\r
  Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _VARIABLE_CHECK_H_\r
#define _VARIABLE_CHECK_H_\r
\r
#include <Uefi/UefiSpec.h>\r
\r
typedef struct _EDKII_VAR_CHECK_PROTOCOL    EDKII_VAR_CHECK_PROTOCOL;\r
\r
#define EDKII_VAR_CHECK_PROTOCOL_GUID { \\r
  0xaf23b340, 0x97b4, 0x4685, { 0x8d, 0x4f, 0xa3, 0xf2, 0x81, 0x69, 0xb2, 0x1d } \\r
};\r
\r
typedef EFI_SET_VARIABLE VAR_CHECK_SET_VARIABLE_CHECK_HANDLER;\r
\r
/**\r
  Register SetVariable check handler.\r
  Variable driver will call the handler to do check before\r
  really setting the variable into variable storage.\r
\r
  @param[in] Handler            Pointer to the 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 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
typedef\r
EFI_STATUS\r
(EFIAPI * EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER) (\r
  IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER   Handler\r
  );\r
\r
#define VAR_CHECK_VARIABLE_PROPERTY_REVISION      0x0001\r
//\r
// 1. Set by VariableLock PROTOCOL\r
// 2. Set by VarCheck PROTOCOL\r
//\r
// If set, other fields for check will be ignored.\r
//\r
#define VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY     BIT0\r
\r
typedef struct {\r
  UINT16                            Revision;\r
  UINT16                            Property;\r
  UINT32                            Attributes;\r
  UINTN                             MinSize;\r
  UINTN                             MaxSize;\r
} VAR_CHECK_VARIABLE_PROPERTY;\r
\r
typedef struct {\r
  EFI_GUID                      *Guid;\r
  CHAR16                        *Name;\r
  VAR_CHECK_VARIABLE_PROPERTY   VariableProperty;\r
} VARIABLE_ENTRY_PROPERTY;\r
\r
/**\r
  Variable property set.\r
  Variable driver will do check according to the VariableProperty before\r
  really setting the variable into variable storage.\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
typedef\r
EFI_STATUS\r
(EFIAPI * EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET) (\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
typedef\r
EFI_STATUS\r
(EFIAPI * EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET) (\r
  IN CHAR16                         *Name,\r
  IN EFI_GUID                       *Guid,\r
  OUT VAR_CHECK_VARIABLE_PROPERTY   *VariableProperty\r
  );\r
\r
struct _EDKII_VAR_CHECK_PROTOCOL {\r
  EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER   RegisterSetVariableCheckHandler;\r
  EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET                 VariablePropertySet;\r
  EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET                 VariablePropertyGet;\r
};\r
\r
extern EFI_GUID gEdkiiVarCheckProtocolGuid;\r
\r
#endif\r
\r