]> git.proxmox.com Git - mirror_edk2.git/blame - Vlv2DeviceRefCodePkg/Include/Protocol/PttPassThru.h
Sync the branch changes to trunk.
[mirror_edk2.git] / Vlv2DeviceRefCodePkg / Include / Protocol / PttPassThru.h
CommitLineData
f4e7aa05
TH
1/*++\r
2\r
3 Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>\r
4 \r
5 This program and the accompanying materials are licensed and made available under\r
6 the terms and conditions of the BSD License that accompanies this distribution. \r
7 The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php. \r
9 \r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12 \r
13--*/\r
14\r
15#ifndef _EFI_PTT_PASS_THRU_H\r
16#define _EFI_PTT_PASS_THRU_H\r
17\r
18#define PTT_PASS_THRU_PROTOCOL_GUID \\r
19 { \\r
20 0x73e2576, 0xf6c1, 0x4b91, 0x92, 0xa9, 0xd4, 0x67, 0x5d, 0xda, 0x34, 0xb1 \\r
21 }\r
22// {073E2576-F6C1-4b91-92A9-D4675DDA34B1}\r
23//static const GUID <<name>> = \r
24//{ 0x73e2576, 0xf6c1, 0x4b91, { 0x92, 0xa9, 0xd4, 0x67, 0x5d, 0xda, 0x34, 0xb1 } };\r
25\r
26\r
27//#define EFI_PTT_PROTOCOL_GUID HECI_PROTOCOL_GUID\r
28\r
29typedef struct _PTT_PASS_THRU_PROTOCOL PTT_PASS_THRU_PROTOCOL;\r
30\r
31/**\r
32 This service enables the sending of commands to the TPM2.\r
33\r
34 @param[in] InputParameterBlockSize Size of the TPM2 input parameter block.\r
35 @param[in] InputParameterBlock Pointer to the TPM2 input parameter block.\r
36 @param[in,out] OutputParameterBlockSize Size of the TPM2 output parameter block.\r
37 @param[in] OutputParameterBlock Pointer to the TPM2 output parameter block.\r
38\r
39 @retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.\r
40 @retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.\r
41 @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small. \r
42**/\r
43typedef\r
44EFI_STATUS\r
45(EFIAPI *TPM2_SUBMIT_COMMAND) (\r
46 IN PTT_PASS_THRU_PROTOCOL *This,\r
47 IN UINT32 InputParameterBlockSize,\r
48 IN UINT8 *InputParameterBlock,\r
49 IN OUT UINT32 *OutputParameterBlockSize,\r
50 IN UINT8 *OutputParameterBlock\r
51 );\r
52\r
53/**\r
54 This service requests use TPM2.\r
55\r
56 @retval EFI_SUCCESS Get the control of TPM2 chip.\r
57 @retval EFI_NOT_FOUND TPM2 not found.\r
58 @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
59**/\r
60typedef\r
61EFI_STATUS\r
62(EFIAPI *TPM2_REQUEST_USE_TPM) (\r
63 IN PTT_PASS_THRU_PROTOCOL *This\r
64 );\r
65\r
66typedef struct {\r
67 EFI_GUID ProviderGuid;\r
68 TPM2_SUBMIT_COMMAND Tpm2SubmitCommand;\r
69 TPM2_REQUEST_USE_TPM Tpm2RequestUseTpm;\r
70} PTT_TPM2_DEVICE_INTERFACE;\r
71\r
72\r
73/**\r
74 This service register TPM2 device.\r
75\r
76 @param Tpm2Device TPM2 device\r
77\r
78 @retval EFI_SUCCESS This TPM2 device is registered successfully.\r
79 @retval EFI_UNSUPPORTED System does not support register this TPM2 device.\r
80 @retval EFI_ALREADY_STARTED System already register this TPM2 device.\r
81**/\r
82typedef\r
83EFI_STATUS\r
84(EFIAPI *TPM2_REGISTER_TPM2_DEVICE_LIB) (\r
85 IN PTT_PASS_THRU_PROTOCOL *This,\r
86 IN PTT_TPM2_DEVICE_INTERFACE *Tpm2Device\r
87 );\r
88 \r
89typedef struct _PTT_PASS_THRU_PROTOCOL {\r
90 TPM2_SUBMIT_COMMAND Tpm2SubmitCommand;\r
91 TPM2_REQUEST_USE_TPM Tpm2RequestUseTpm;\r
92 TPM2_REGISTER_TPM2_DEVICE_LIB Tpm2RegisterTpm2DeviceLib;\r
93} PTT_PASS_THRU_PROTOCOL;\r
94\r
95extern EFI_GUID gPttPassThruProtocolGuid;\r
96\r
97#endif // _EFI_HECI_H\r