Fix PCD help information format and a typo.
[mirror_edk2.git] / SecurityPkg / Include / Library / TrEEPhysicalPresenceLib.h
1 /** @file
2 Ihis library is intended to be used by BDS modules.
3 This library will execute TPM2 request.
4
5 Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #ifndef _TREE_PHYSICAL_PRESENCE_LIB_H_
17 #define _TREE_PHYSICAL_PRESENCE_LIB_H_
18
19 #include <IndustryStandard/Tpm20.h>
20 #include <Protocol/TrEEProtocol.h>
21
22 /**
23 Check and execute the pending TPM request.
24
25 The TPM request may come from OS or BIOS. This API will display request information and wait
26 for user confirmation if TPM request exists. The TPM request will be sent to TPM device after
27 the TPM request is confirmed, and one or more reset may be required to make TPM request to
28 take effect.
29
30 This API should be invoked after console in and console out are all ready as they are required
31 to display request information and get user input to confirm the request.
32
33 @param PlatformAuth platform auth value. NULL means no platform auth change.
34 **/
35 VOID
36 EFIAPI
37 TrEEPhysicalPresenceLibProcessRequest (
38 IN TPM2B_AUTH *PlatformAuth OPTIONAL
39 );
40
41 /**
42 Check if the pending TPM request needs user input to confirm.
43
44 The TPM request may come from OS. This API will check if TPM request exists and need user
45 input to confirmation.
46
47 @retval TRUE TPM needs input to confirm user physical presence.
48 @retval FALSE TPM doesn't need input to confirm user physical presence.
49
50 **/
51 BOOLEAN
52 EFIAPI
53 TrEEPhysicalPresenceLibNeedUserConfirm(
54 VOID
55 );
56
57 #endif