SecurityPkg/Include/Library/TcgPhysicalPresenceLib.h

   1 /** @file
   2   This library is intended to be used by BDS modules.
   3   This library will lock TPM after executing TPM request.
   4
   5 Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _TCG_PHYSICAL_PRESENCE_LIB_H_
  11 #define _TCG_PHYSICAL_PRESENCE_LIB_H_
  12
  13 /**
  14   Check and execute the pending TPM request and Lock TPM.
  15
  16   The TPM request may come from OS or BIOS. This API will display request information and wait
  17   for user confirmation if TPM request exists. The TPM request will be sent to TPM device after
  18   the TPM request is confirmed, and one or more reset may be required to make TPM request to
  19   take effect. At last, it will lock TPM to prevent TPM state change by malware.
  20
  21   This API should be invoked after console in and console out are all ready as they are required
  22   to display request information and get user input to confirm the request. This API should also
  23   be invoked as early as possible as TPM is locked in this function.
  24
  25 **/
  26 VOID
  27 EFIAPI
  28 TcgPhysicalPresenceLibProcessRequest (
  29   VOID
  30   );
  31
  32 /**
  33   Check if the pending TPM request needs user input to confirm.
  34
  35   The TPM request may come from OS. This API will check if TPM request exists and need user
  36   input to confirmation.
  37
  38   @retval    TRUE        TPM needs input to confirm user physical presence.
  39   @retval    FALSE       TPM doesn't need input to confirm user physical presence.
  40
  41 **/
  42 BOOLEAN
  43 EFIAPI
  44 TcgPhysicalPresenceLibNeedUserConfirm(
  45   VOID
  46   );
  47
  48 #endif