]>
Commit | Line | Data |
---|---|---|
1abfa4ce | 1 | /** @file\r |
07309c3d | 2 | This library is to support TCG PC Client Platform Physical Presence Interface Specification\r |
1abfa4ce JY |
3 | Family "2.0" part, >= 128 Vendor Specific PPI Operation.\r |
4 | \r | |
5 | The Vendor Specific PPI operation may change TPM state, BIOS TPM management\r | |
6 | flags, and may need additional boot cycle.\r | |
b3548d32 | 7 | \r |
1abfa4ce JY |
8 | Caution: This function may receive untrusted input.\r |
9 | \r | |
b3548d32 LG |
10 | Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r |
11 | This program and the accompanying materials\r | |
12 | are licensed and made available under the terms and conditions of the BSD License\r | |
13 | which accompanies this distribution. The full text of the license may be found at\r | |
1abfa4ce JY |
14 | http://opensource.org/licenses/bsd-license.php\r |
15 | \r | |
b3548d32 | 16 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
1abfa4ce JY |
17 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
18 | \r | |
19 | **/\r | |
20 | \r | |
21 | #ifndef _TCG2_PP_VENDOR_LIB_H_\r | |
22 | #define _TCG2_PP_VENDOR_LIB_H_\r | |
23 | \r | |
24 | #include <IndustryStandard/Tpm20.h>\r | |
25 | #include <Protocol/Tcg2Protocol.h>\r | |
26 | #include <Library/Tcg2PhysicalPresenceLib.h>\r | |
27 | \r | |
28 | /**\r | |
29 | Check and execute the requested physical presence command.\r | |
30 | \r | |
31 | This API should be invoked in BIOS boot phase to process pending request.\r | |
b3548d32 | 32 | \r |
1abfa4ce | 33 | Caution: This function may receive untrusted input.\r |
b3548d32 | 34 | \r |
1abfa4ce JY |
35 | If OperationRequest < 128, then ASSERT().\r |
36 | \r | |
37 | @param[in] PlatformAuth platform auth value. NULL means no platform auth change.\r | |
38 | @param[in] OperationRequest TPM physical presence operation request.\r | |
39 | @param[in, out] ManagementFlags BIOS TPM Management Flags.\r | |
40 | @param[out] ResetRequired If reset is required to vendor settings in effect.\r | |
41 | True, it indicates the reset is required.\r | |
42 | False, it indicates the reset is not required.\r | |
43 | \r | |
44 | @return TPM Operation Response to OS Environment.\r | |
45 | **/\r | |
46 | UINT32\r | |
47 | EFIAPI\r | |
48 | Tcg2PpVendorLibExecutePendingRequest (\r | |
49 | IN TPM2B_AUTH *PlatformAuth, OPTIONAL\r | |
50 | IN UINT32 OperationRequest,\r | |
51 | IN OUT UINT32 *ManagementFlags,\r | |
52 | OUT BOOLEAN *ResetRequired\r | |
53 | );\r | |
54 | \r | |
55 | /**\r | |
56 | Check if there is a valid physical presence command request.\r | |
57 | \r | |
58 | This API should be invoked in BIOS boot phase to process pending request.\r | |
b3548d32 | 59 | \r |
1abfa4ce JY |
60 | Caution: This function may receive untrusted input.\r |
61 | \r | |
62 | If OperationRequest < 128, then ASSERT().\r | |
63 | \r | |
64 | @param[in] OperationRequest TPM physical presence operation request.\r | |
65 | @param[in] ManagementFlags BIOS TPM Management Flags.\r | |
66 | @param[out] RequestConfirmed If the physical presence operation command required user confirm from UI.\r | |
67 | True, it indicates the command doesn't require user confirm.\r | |
68 | False, it indicates the command need user confirm from UI.\r | |
69 | \r | |
70 | @retval TRUE Physical Presence operation command is valid.\r | |
71 | @retval FALSE Physical Presence operation command is invalid.\r | |
72 | **/\r | |
73 | BOOLEAN\r | |
74 | EFIAPI\r | |
75 | Tcg2PpVendorLibHasValidRequest (\r | |
76 | IN UINT32 OperationRequest,\r | |
77 | IN UINT32 ManagementFlags,\r | |
78 | OUT BOOLEAN *RequestConfirmed\r | |
79 | );\r | |
80 | \r | |
81 | /**\r | |
82 | The callback for TPM vendor specific physical presence which is called for\r | |
83 | Submit TPM Operation Request to Pre-OS Environment and\r | |
84 | Submit TPM Operation Request to Pre-OS Environment 2.\r | |
85 | \r | |
86 | This API should be invoked in OS runtime phase to interface with ACPI method.\r | |
87 | \r | |
88 | Caution: This function may receive untrusted input.\r | |
b3548d32 | 89 | \r |
1abfa4ce JY |
90 | If OperationRequest < 128, then ASSERT().\r |
91 | \r | |
92 | @param[in] OperationRequest TPM physical presence operation request.\r | |
93 | @param[in] ManagementFlags BIOS TPM Management Flags.\r | |
94 | @param[in] RequestParameter Extra parameter from the passed package.\r | |
95 | \r | |
96 | @return Return Code for Submit TPM Operation Request to Pre-OS Environment and\r | |
97 | Submit TPM Operation Request to Pre-OS Environment 2.\r | |
98 | **/\r | |
99 | UINT32\r | |
100 | EFIAPI\r | |
101 | Tcg2PpVendorLibSubmitRequestToPreOSFunction (\r | |
102 | IN UINT32 OperationRequest,\r | |
103 | IN UINT32 ManagementFlags,\r | |
104 | IN UINT32 RequestParameter\r | |
105 | );\r | |
106 | \r | |
107 | /**\r | |
108 | The callback for TPM vendor specific physical presence which is called for\r | |
109 | Get User Confirmation Status for Operation.\r | |
110 | \r | |
111 | This API should be invoked in OS runtime phase to interface with ACPI method.\r | |
112 | \r | |
113 | Caution: This function may receive untrusted input.\r | |
b3548d32 | 114 | \r |
1abfa4ce JY |
115 | If OperationRequest < 128, then ASSERT().\r |
116 | \r | |
117 | @param[in] OperationRequest TPM physical presence operation request.\r | |
118 | @param[in] ManagementFlags BIOS TPM Management Flags.\r | |
119 | \r | |
120 | @return Return Code for Get User Confirmation Status for Operation.\r | |
121 | **/\r | |
122 | UINT32\r | |
123 | EFIAPI\r | |
124 | Tcg2PpVendorLibGetUserConfirmationStatusFunction (\r | |
125 | IN UINT32 OperationRequest,\r | |
126 | IN UINT32 ManagementFlags\r | |
127 | );\r | |
128 | \r | |
129 | #endif\r |