4 * Copyright IBM, Corp. 2013
7 * Stefan Berger <stefanb@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
16 #include "qom/object.h"
17 #include "qemu-common.h"
18 #include "qapi-types.h"
19 #include "qemu/option.h"
20 #include "sysemu/tpm.h"
21 #include "qapi/error.h"
23 #define TYPE_TPM_BACKEND "tpm-backend"
24 #define TPM_BACKEND(obj) \
25 OBJECT_CHECK(TPMBackend, (obj), TYPE_TPM_BACKEND)
26 #define TPM_BACKEND_GET_CLASS(obj) \
27 OBJECT_GET_CLASS(TPMBackendClass, (obj), TYPE_TPM_BACKEND)
28 #define TPM_BACKEND_CLASS(klass) \
29 OBJECT_CLASS_CHECK(TPMBackendClass, (klass), TYPE_TPM_BACKEND)
31 typedef struct TPMBackendClass TPMBackendClass
;
32 typedef struct TPMBackend TPMBackend
;
34 typedef struct TPMBackendCmd
{
49 bool had_startup_error
;
55 QLIST_ENTRY(TPMBackend
) list
;
58 struct TPMBackendClass
{
59 ObjectClass parent_class
;
62 const QemuOptDesc
*opts
;
63 /* get a descriptive text of the backend to display to the user */
66 TPMBackend
*(*create
)(QemuOpts
*opts
);
68 /* start up the TPM on the backend - optional */
69 int (*startup_tpm
)(TPMBackend
*t
, size_t buffersize
);
72 void (*reset
)(TPMBackend
*t
);
74 void (*cancel_cmd
)(TPMBackend
*t
);
77 bool (*get_tpm_established_flag
)(TPMBackend
*t
);
80 int (*reset_tpm_established_flag
)(TPMBackend
*t
, uint8_t locty
);
82 TPMVersion (*get_tpm_version
)(TPMBackend
*t
);
84 size_t (*get_buffer_size
)(TPMBackend
*t
);
86 TpmTypeOptions
*(*get_tpm_options
)(TPMBackend
*t
);
88 void (*handle_request
)(TPMBackend
*s
, TPMBackendCmd
*cmd
, Error
**errp
);
92 * tpm_backend_get_type:
95 * Returns the TpmType of the backend.
97 enum TpmType
tpm_backend_get_type(TPMBackend
*s
);
101 * @s: the backend to initialized
102 * @tpmif: TPM interface
103 * @datacb: callback for sending data to frontend
104 * @errp: a pointer to return the #Error object if an error occurs.
106 * Initialize the backend with the given variables.
108 * Returns 0 on success.
110 int tpm_backend_init(TPMBackend
*s
, TPMIf
*tpmif
, Error
**errp
);
113 * tpm_backend_startup_tpm:
114 * @s: the backend whose TPM support is to be started
115 * @buffersize: the buffer size the TPM is supposed to use,
116 * 0 to leave it as-is
118 * Returns 0 on success.
120 int tpm_backend_startup_tpm(TPMBackend
*s
, size_t buffersize
);
123 * tpm_backend_had_startup_error:
124 * @s: the backend to query for a statup error
126 * Check whether the backend had an error during startup. Returns
127 * false if no error occurred and the backend can be used, true
130 bool tpm_backend_had_startup_error(TPMBackend
*s
);
133 * tpm_backend_deliver_request:
134 * @s: the backend to send the request to
135 * @cmd: the command to deliver
137 * Send a request to the backend. The backend will then send the request
138 * to the TPM implementation.
140 void tpm_backend_deliver_request(TPMBackend
*s
, TPMBackendCmd
*cmd
);
144 * @s: the backend to reset
146 * Reset the backend into a well defined state with all previous errors
149 void tpm_backend_reset(TPMBackend
*s
);
152 * tpm_backend_cancel_cmd:
155 * Cancel any ongoing command being processed by the TPM implementation
156 * on behalf of the QEMU guest.
158 void tpm_backend_cancel_cmd(TPMBackend
*s
);
161 * tpm_backend_get_tpm_established_flag:
164 * Get the TPM establishment flag. This function may be called very
165 * frequently by the frontend since for example in the TIS implementation
166 * this flag is part of a register.
168 bool tpm_backend_get_tpm_established_flag(TPMBackend
*s
);
171 * tpm_backend_reset_tpm_established_flag:
173 * @locty: the locality number
175 * Reset the TPM establishment flag.
177 int tpm_backend_reset_tpm_established_flag(TPMBackend
*s
, uint8_t locty
);
180 * tpm_backend_get_tpm_version:
181 * @s: the backend to call into
183 * Get the TPM Version that is emulated at the backend.
185 * Returns TPMVersion.
187 TPMVersion
tpm_backend_get_tpm_version(TPMBackend
*s
);
190 * tpm_backend_get_buffer_size:
191 * @s: the backend to call into
193 * Get the TPM's buffer size.
195 * Returns buffer size.
197 size_t tpm_backend_get_buffer_size(TPMBackend
*s
);
200 * tpm_backend_finish_sync:
201 * @s: the backend to call into
203 * Finish the pending command synchronously (this will call aio_poll()
204 * on qemu main AIOContext until it ends)
206 void tpm_backend_finish_sync(TPMBackend
*s
);
209 * tpm_backend_query_tpm:
212 * Query backend tpm info
214 * Returns newly allocated TPMInfo
216 TPMInfo
*tpm_backend_query_tpm(TPMBackend
*s
);
218 TPMBackend
*qemu_find_tpm_be(const char *id
);