1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/** @file
* PDM - Pluggable Device Manager, TPM related interfaces.
*/
/*
* Copyright (C) 2021-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef VBOX_INCLUDED_vmm_pdmtpmifs_h
#define VBOX_INCLUDED_vmm_pdmtpmifs_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/types.h>
RT_C_DECLS_BEGIN
/** @defgroup grp_pdm_ifs_tpm PDM TPM Interfaces
* @ingroup grp_pdm_interfaces
* @{
*/
/** Pointer to a TPM port interface. */
typedef struct PDMITPMPORT *PPDMITPMPORT;
/**
* TPM port interface (down).
*/
typedef struct PDMITPMPORT
{
/**
* @todo
*/
DECLR3CALLBACKMEMBER(int, pfnDummy, (PPDMITPMPORT pInterface));
} PDMITPMPORT;
/** PDMITPMPORT interface ID. */
#define PDMITPMPORT_IID "1e57710f-f820-47ec-afa6-2713195f8f94"
/**
* TPM version enumeration.
*/
typedef enum TPMVERSION
{
/** Invalid TPM version, don't use. */
TPMVERSION_INVALID = 0,
/** TPM works according to version 1.2 of the specification. */
TPMVERSION_1_2,
/** TPM works according to version 2.0 of the specification. */
TPMVERSION_2_0,
/** TPM version is unknown. */
TPMVERSION_UNKNOWN
} TPMVERSION;
/** Pointer to a TPM interface. */
typedef struct PDMITPMCONNECTOR *PPDMITPMCONNECTOR;
/**
* TPM interface (up).
* Pairs with PDMITPMPORT.
*/
typedef struct PDMITPMCONNECTOR
{
/**
* Returns the version of the TPM implemented by the driver below.
*
* @returns The TPM version.
* @param pInterface Pointer to the interface structure containing the called function pointer.
*/
DECLR3CALLBACKMEMBER(TPMVERSION, pfnGetVersion, (PPDMITPMCONNECTOR pInterface));
/**
* Returns the maximum supported locality of the driver below.
*
* @returns The maximum supported locality (0-4).
* @param pInterface Pointer to the interface structure containing the called function pointer.
*/
DECLR3CALLBACKMEMBER(uint32_t, pfnGetLocalityMax, (PPDMITPMCONNECTOR pInterface));
/**
* Returns the command/response buffer size of the driver below.
*
* @returns Buffer size in bytes.
* @param pInterface Pointer to the interface structure containing the called function pointer.
*/
DECLR3CALLBACKMEMBER(uint32_t, pfnGetBufferSize, (PPDMITPMCONNECTOR pInterface));
/**
* Returns the status of the established flag.
*
* @returns Status of the established flag.
* @param pInterface Pointer to the interface structure containing the called function pointer.
*/
DECLR3CALLBACKMEMBER(bool, pfnGetEstablishedFlag, (PPDMITPMCONNECTOR pInterface));
/**
* Resets the TPM established flag.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param bLoc The locality issuing this request.
*/
DECLR3CALLBACKMEMBER(int, pfnResetEstablishedFlag, (PPDMITPMCONNECTOR pInterface, uint8_t bLoc));
/**
* Executes the given command.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param bLoc The locality the command is issued from.
* @param pvCmd Pointer to the command data.
* @param cbCmd Size of the command in bytes.
* @param pvResp Where to store the response data.
* @param cbResp Size of the response buffer in bytes.
*/
DECLR3CALLBACKMEMBER(int, pfnCmdExec, (PPDMITPMCONNECTOR pInterface, uint8_t bLoc, const void *pvCmd, size_t cbCmd, void *pvResp, size_t cbResp));
/**
* Cancels the currently executed command.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
*/
DECLR3CALLBACKMEMBER(int, pfnCmdCancel, (PPDMITPMCONNECTOR pInterface));
} PDMITPMCONNECTOR;
/** PDMITPMCONNECTOR interface ID. */
#define PDMITPMCONNECTOR_IID "30afefd8-c11f-4e2a-a746-424e3d99fa86"
/** @} */
RT_C_DECLS_END
#endif /* !VBOX_INCLUDED_vmm_pdmtpmifs_h */
|
