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