SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / Include / Library / TcgPhysicalPresenceLib.h

/** @file\r
  This library is intended to be used by BDS modules.\r
  This library will lock TPM after executing TPM request.\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _TCG_PHYSICAL_PRESENCE_LIB_H_\r
#define _TCG_PHYSICAL_PRESENCE_LIB_H_\r
\r
/**\r
  Check and execute the pending TPM request and Lock TPM.\r
\r
  The TPM request may come from OS or BIOS. This API will display request information and wait\r
  for user confirmation if TPM request exists. The TPM request will be sent to TPM device after\r
  the TPM request is confirmed, and one or more reset may be required to make TPM request to\r
  take effect. At last, it will lock TPM to prevent TPM state change by malware.\r
\r
  This API should be invoked after console in and console out are all ready as they are required\r
  to display request information and get user input to confirm the request. This API should also\r
  be invoked as early as possible as TPM is locked in this function.\r
\r
**/\r
VOID\r
EFIAPI\r
TcgPhysicalPresenceLibProcessRequest (\r
  VOID\r
  );\r
\r
/**\r
  Check if the pending TPM request needs user input to confirm.\r
\r
  The TPM request may come from OS. This API will check if TPM request exists and need user\r
  input to confirmation.\r
\r
  @retval    TRUE        TPM needs input to confirm user physical presence.\r
  @retval    FALSE       TPM doesn't need input to confirm user physical presence.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
TcgPhysicalPresenceLibNeedUserConfirm(\r
  VOID\r
  );\r
\r
#endif\r