SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / Library / TcgPpVendorLibNull / TcgPpVendorLibNull.c

/** @file\r
  NULL TCG PP Vendor library instance that does not support any vendor specific PPI.\r
\r
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Library/DebugLib.h>\r
#include <Library/TcgPpVendorLib.h>\r
\r
/**\r
  Check and execute the requested physical presence command.\r
\r
  This API should be invoked in BIOS boot phase to process pending request.\r
\r
  Caution: This function may receive untrusted input.\r
\r
  If OperationRequest < 128, then ASSERT().\r
\r
  @param[in]      OperationRequest TPM physical presence operation request.\r
  @param[in, out] ManagementFlags  BIOS TPM Management Flags.\r
  @param[out]     ResetRequired    If reset is required to vendor settings in effect.\r
                                   True, it indicates the reset is required.\r
                                   False, it indicates the reset is not required.\r
\r
  @return TPM Operation Response to OS Environment.\r
**/\r
UINT32\r
EFIAPI\r
TcgPpVendorLibExecutePendingRequest (\r
  IN UINT32                 OperationRequest,\r
  IN OUT UINT32             *ManagementFlags,\r
  OUT BOOLEAN               *ResetRequired\r
  )\r
{\r
  ASSERT (OperationRequest >= TCG_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION);\r
  return TCG_PP_OPERATION_RESPONSE_BIOS_FAILURE;\r
}\r
\r
/**\r
  Check if there is a valid physical presence command request.\r
\r
  This API should be invoked in BIOS boot phase to process pending request.\r
\r
  Caution: This function may receive untrusted input.\r
\r
  If OperationRequest < 128, then ASSERT().\r
\r
  @param[in]      OperationRequest TPM physical presence operation request.\r
  @param[in]      ManagementFlags  BIOS TPM Management Flags.\r
  @param[out]     RequestConfirmed If the physical presence operation command required user confirm from UI.\r
                                   True, it indicates the command doesn't require user confirm.\r
                                   False, it indicates the command need user confirm from UI.\r
\r
  @retval  TRUE        Physical Presence operation command is valid.\r
  @retval  FALSE       Physical Presence operation command is invalid.\r
**/\r
BOOLEAN\r
EFIAPI\r
TcgPpVendorLibHasValidRequest (\r
  IN UINT32                 OperationRequest,\r
  IN UINT32                 ManagementFlags,\r
  OUT BOOLEAN               *RequestConfirmed\r
  )\r
{\r
  ASSERT (OperationRequest >= TCG_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION);\r
  return FALSE;\r
}\r
\r
/**\r
  The callback for TPM vendor specific physical presence which is called for\r
  Submit TPM Operation Request to Pre-OS Environment and\r
  Submit TPM Operation Request to Pre-OS Environment 2.\r
\r
  This API should be invoked in OS runtime phase to interface with ACPI method.\r
\r
  Caution: This function may receive untrusted input.\r
\r
  If OperationRequest < 128, then ASSERT().\r
\r
  @param[in]      OperationRequest TPM physical presence operation request.\r
  @param[in]      ManagementFlags  BIOS TPM Management Flags.\r
\r
  @return Return Code for Submit TPM Operation Request to Pre-OS Environment and\r
          Submit TPM Operation Request to Pre-OS Environment 2.\r
**/\r
UINT32\r
EFIAPI\r
TcgPpVendorLibSubmitRequestToPreOSFunction (\r
  IN UINT32                 OperationRequest,\r
  IN UINT32                 ManagementFlags\r
  )\r
{\r
  ASSERT (OperationRequest >= TCG_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION);\r
  return TCG_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED;\r
}\r
\r
/**\r
  The callback for TPM vendor specific physical presence which is called for\r
  Get User Confirmation Status for Operation.\r
\r
  This API should be invoked in OS runtime phase to interface with ACPI method.\r
\r
  Caution: This function may receive untrusted input.\r
\r
  If OperationRequest < 128, then ASSERT().\r
\r
  @param[in]      OperationRequest TPM physical presence operation request.\r
  @param[in]      ManagementFlags  BIOS TPM Management Flags.\r
\r
  @return Return Code for Get User Confirmation Status for Operation.\r
**/\r
UINT32\r
EFIAPI\r
TcgPpVendorLibGetUserConfirmationStatusFunction (\r
  IN UINT32                 OperationRequest,\r
  IN UINT32                 ManagementFlags\r
  )\r
{\r
  ASSERT (OperationRequest >= TCG_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION);\r
  return TCG_PP_GET_USER_CONFIRMATION_NOT_IMPLEMENTED;\r
}\r