MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Library / AuthVariableLibNull / AuthVariableLibNull.c

/** @file\r
  Implements NULL authenticated variable services.\r
\r
Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Library/AuthVariableLib.h>\r
#include <Library/DebugLib.h>\r
\r
/**\r
  Initialization for authenticated varibale services.\r
  If this initialization returns error status, other APIs will not work\r
  and expect to be not called then.\r
\r
  @param[in]  AuthVarLibContextIn   Pointer to input auth variable lib context.\r
  @param[out] AuthVarLibContextOut  Pointer to output auth variable lib context.\r
\r
  @retval EFI_SUCCESS               Function successfully executed.\r
  @retval EFI_INVALID_PARAMETER     If AuthVarLibContextIn == NULL or AuthVarLibContextOut == NULL.\r
  @retval EFI_OUT_OF_RESOURCES      Fail to allocate enough resource.\r
  @retval EFI_UNSUPPORTED           Unsupported to process authenticated variable.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AuthVariableLibInitialize (\r
  IN  AUTH_VAR_LIB_CONTEXT_IN   *AuthVarLibContextIn,\r
  OUT AUTH_VAR_LIB_CONTEXT_OUT  *AuthVarLibContextOut\r
  )\r
{\r
  //\r
  // Do nothing, just return EFI_UNSUPPORTED.\r
  //\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set.\r
\r
  @param[in] VariableName           Name of the variable.\r
  @param[in] VendorGuid             Variable vendor GUID.\r
  @param[in] Data                   Data pointer.\r
  @param[in] DataSize               Size of Data.\r
  @param[in] Attributes             Attribute value of the variable.\r
\r
  @retval EFI_SUCCESS               The firmware has successfully stored the variable and its data as\r
                                    defined by the Attributes.\r
  @retval EFI_INVALID_PARAMETER     Invalid parameter.\r
  @retval EFI_WRITE_PROTECTED       Variable is write-protected.\r
  @retval EFI_OUT_OF_RESOURCES      There is not enough resource.\r
  @retval EFI_SECURITY_VIOLATION    The variable is with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS\r
                                    set, but the AuthInfo does NOT pass the validation\r
                                    check carried out by the firmware.\r
  @retval EFI_UNSUPPORTED           Unsupported to process authenticated variable.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AuthVariableLibProcessVariable (\r
  IN CHAR16         *VariableName,\r
  IN EFI_GUID       *VendorGuid,\r
  IN VOID           *Data,\r
  IN UINTN          DataSize,\r
  IN UINT32         Attributes\r
  )\r
{\r
  ASSERT (FALSE);\r
  return EFI_UNSUPPORTED;\r
}\r