2013-03-28 12:26:21 +01:00
|
|
|
/*
|
|
|
|
* QEMU TPM Backend
|
|
|
|
*
|
|
|
|
* Copyright IBM, Corp. 2013
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Stefan Berger <stefanb@us.ibm.com>
|
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU GPL, version 2 or later.
|
|
|
|
* See the COPYING file in the top-level directory.
|
|
|
|
*/
|
|
|
|
|
2016-06-29 10:12:57 +02:00
|
|
|
#ifndef TPM_BACKEND_H
|
|
|
|
#define TPM_BACKEND_H
|
2013-03-28 12:26:21 +01:00
|
|
|
|
|
|
|
#include "qom/object.h"
|
|
|
|
#include "qemu-common.h"
|
|
|
|
#include "qapi-types.h"
|
|
|
|
#include "qemu/option.h"
|
2013-04-02 18:28:41 +02:00
|
|
|
#include "sysemu/tpm.h"
|
2013-03-28 12:26:21 +01:00
|
|
|
|
|
|
|
#define TYPE_TPM_BACKEND "tpm-backend"
|
|
|
|
#define TPM_BACKEND(obj) \
|
|
|
|
OBJECT_CHECK(TPMBackend, (obj), TYPE_TPM_BACKEND)
|
|
|
|
#define TPM_BACKEND_GET_CLASS(obj) \
|
|
|
|
OBJECT_GET_CLASS(TPMBackendClass, (obj), TYPE_TPM_BACKEND)
|
|
|
|
#define TPM_BACKEND_CLASS(klass) \
|
|
|
|
OBJECT_CLASS_CHECK(TPMBackendClass, (klass), TYPE_TPM_BACKEND)
|
|
|
|
|
|
|
|
typedef struct TPMBackendClass TPMBackendClass;
|
|
|
|
typedef struct TPMBackend TPMBackend;
|
2017-10-10 00:55:49 +02:00
|
|
|
|
2017-10-10 00:55:55 +02:00
|
|
|
typedef struct TPMBackendCmd {
|
|
|
|
uint8_t locty;
|
|
|
|
const uint8_t *in;
|
|
|
|
uint32_t in_len;
|
|
|
|
uint8_t *out;
|
|
|
|
uint32_t out_len;
|
|
|
|
bool selftest_done;
|
|
|
|
} TPMBackendCmd;
|
2013-03-28 12:26:21 +01:00
|
|
|
|
|
|
|
struct TPMBackend {
|
|
|
|
Object parent;
|
|
|
|
|
|
|
|
/*< protected >*/
|
2017-11-06 19:39:00 +01:00
|
|
|
TPMIf *tpmif;
|
2013-03-28 12:26:21 +01:00
|
|
|
bool opened;
|
2017-09-29 13:10:14 +02:00
|
|
|
GThreadPool *thread_pool;
|
2017-09-29 13:10:16 +02:00
|
|
|
bool had_startup_error;
|
2017-11-06 19:39:02 +01:00
|
|
|
QEMUBH *bh;
|
2013-03-28 12:26:21 +01:00
|
|
|
|
2017-09-29 13:10:17 +02:00
|
|
|
/* <public> */
|
2013-03-28 12:26:21 +01:00
|
|
|
char *id;
|
|
|
|
enum TpmModel fe_model;
|
|
|
|
|
|
|
|
QLIST_ENTRY(TPMBackend) list;
|
|
|
|
};
|
|
|
|
|
2017-09-29 13:10:14 +02:00
|
|
|
struct TPMBackendClass {
|
|
|
|
ObjectClass parent_class;
|
|
|
|
|
2013-04-02 18:28:41 +02:00
|
|
|
enum TpmType type;
|
2013-04-22 16:41:39 +02:00
|
|
|
const QemuOptDesc *opts;
|
2013-04-02 18:28:41 +02:00
|
|
|
/* get a descriptive text of the backend to display to the user */
|
2017-09-29 13:10:16 +02:00
|
|
|
const char *desc;
|
2013-04-02 18:28:41 +02:00
|
|
|
|
|
|
|
TPMBackend *(*create)(QemuOpts *opts, const char *id);
|
|
|
|
|
|
|
|
/* start up the TPM on the backend */
|
|
|
|
int (*startup_tpm)(TPMBackend *t);
|
|
|
|
|
|
|
|
void (*reset)(TPMBackend *t);
|
|
|
|
|
|
|
|
void (*cancel_cmd)(TPMBackend *t);
|
|
|
|
|
|
|
|
bool (*get_tpm_established_flag)(TPMBackend *t);
|
2015-05-26 22:51:05 +02:00
|
|
|
|
|
|
|
int (*reset_tpm_established_flag)(TPMBackend *t, uint8_t locty);
|
|
|
|
|
|
|
|
TPMVersion (*get_tpm_version)(TPMBackend *t);
|
2017-09-29 13:10:17 +02:00
|
|
|
|
|
|
|
TpmTypeOptions *(*get_tpm_options)(TPMBackend *t);
|
2013-04-02 18:28:41 +02:00
|
|
|
|
2017-10-10 00:55:49 +02:00
|
|
|
void (*opened)(TPMBackend *s, Error **errp);
|
|
|
|
|
2017-10-10 00:55:55 +02:00
|
|
|
void (*handle_request)(TPMBackend *s, TPMBackendCmd *cmd);
|
2017-10-10 00:55:49 +02:00
|
|
|
};
|
2013-03-28 12:26:21 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* tpm_backend_get_type:
|
|
|
|
* @s: the backend
|
|
|
|
*
|
|
|
|
* Returns the TpmType of the backend.
|
|
|
|
*/
|
|
|
|
enum TpmType tpm_backend_get_type(TPMBackend *s);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tpm_backend_init:
|
|
|
|
* @s: the backend to initialized
|
2017-11-06 19:39:00 +01:00
|
|
|
* @tpmif: TPM interface
|
2013-03-28 12:26:21 +01:00
|
|
|
* @datacb: callback for sending data to frontend
|
2017-11-06 19:39:03 +01:00
|
|
|
* @errp: a pointer to return the #Error object if an error occurs.
|
2013-03-28 12:26:21 +01:00
|
|
|
*
|
|
|
|
* Initialize the backend with the given variables.
|
|
|
|
*
|
|
|
|
* Returns 0 on success.
|
|
|
|
*/
|
2017-11-06 19:39:03 +01:00
|
|
|
int tpm_backend_init(TPMBackend *s, TPMIf *tpmif, Error **errp);
|
2013-03-28 12:26:21 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* tpm_backend_startup_tpm:
|
|
|
|
* @s: the backend whose TPM support is to be started
|
|
|
|
*
|
|
|
|
* Returns 0 on success.
|
|
|
|
*/
|
|
|
|
int tpm_backend_startup_tpm(TPMBackend *s);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tpm_backend_had_startup_error:
|
|
|
|
* @s: the backend to query for a statup error
|
|
|
|
*
|
|
|
|
* Check whether the backend had an error during startup. Returns
|
|
|
|
* false if no error occurred and the backend can be used, true
|
|
|
|
* otherwise.
|
|
|
|
*/
|
|
|
|
bool tpm_backend_had_startup_error(TPMBackend *s);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tpm_backend_deliver_request:
|
|
|
|
* @s: the backend to send the request to
|
2017-10-10 00:55:55 +02:00
|
|
|
* @cmd: the command to deliver
|
2013-03-28 12:26:21 +01:00
|
|
|
*
|
|
|
|
* Send a request to the backend. The backend will then send the request
|
|
|
|
* to the TPM implementation.
|
|
|
|
*/
|
2017-10-10 00:55:55 +02:00
|
|
|
void tpm_backend_deliver_request(TPMBackend *s, TPMBackendCmd *cmd);
|
2013-03-28 12:26:21 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* tpm_backend_reset:
|
|
|
|
* @s: the backend to reset
|
|
|
|
*
|
|
|
|
* Reset the backend into a well defined state with all previous errors
|
|
|
|
* reset.
|
|
|
|
*/
|
|
|
|
void tpm_backend_reset(TPMBackend *s);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tpm_backend_cancel_cmd:
|
|
|
|
* @s: the backend
|
|
|
|
*
|
|
|
|
* Cancel any ongoing command being processed by the TPM implementation
|
|
|
|
* on behalf of the QEMU guest.
|
|
|
|
*/
|
|
|
|
void tpm_backend_cancel_cmd(TPMBackend *s);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tpm_backend_get_tpm_established_flag:
|
|
|
|
* @s: the backend
|
|
|
|
*
|
|
|
|
* Get the TPM establishment flag. This function may be called very
|
|
|
|
* frequently by the frontend since for example in the TIS implementation
|
|
|
|
* this flag is part of a register.
|
|
|
|
*/
|
|
|
|
bool tpm_backend_get_tpm_established_flag(TPMBackend *s);
|
|
|
|
|
2015-05-26 22:51:05 +02:00
|
|
|
/**
|
|
|
|
* tpm_backend_reset_tpm_established_flag:
|
|
|
|
* @s: the backend
|
|
|
|
* @locty: the locality number
|
|
|
|
*
|
|
|
|
* Reset the TPM establishment flag.
|
|
|
|
*/
|
|
|
|
int tpm_backend_reset_tpm_established_flag(TPMBackend *s, uint8_t locty);
|
|
|
|
|
2013-03-28 12:26:21 +01:00
|
|
|
/**
|
|
|
|
* tpm_backend_open:
|
|
|
|
* @s: the backend to open
|
|
|
|
* @errp: a pointer to return the #Error object if an error occurs.
|
|
|
|
*
|
|
|
|
* This function will open the backend if it is not already open. Calling this
|
|
|
|
* function on an already opened backend will not result in an error.
|
|
|
|
*/
|
|
|
|
void tpm_backend_open(TPMBackend *s, Error **errp);
|
|
|
|
|
2015-05-26 22:51:05 +02:00
|
|
|
/**
|
|
|
|
* tpm_backend_get_tpm_version:
|
|
|
|
* @s: the backend to call into
|
|
|
|
*
|
|
|
|
* Get the TPM Version that is emulated at the backend.
|
|
|
|
*
|
|
|
|
* Returns TPMVersion.
|
|
|
|
*/
|
|
|
|
TPMVersion tpm_backend_get_tpm_version(TPMBackend *s);
|
|
|
|
|
2017-09-29 13:10:17 +02:00
|
|
|
/**
|
|
|
|
* tpm_backend_query_tpm:
|
|
|
|
* @s: the backend
|
|
|
|
*
|
|
|
|
* Query backend tpm info
|
|
|
|
*
|
|
|
|
* Returns newly allocated TPMInfo
|
|
|
|
*/
|
|
|
|
TPMInfo *tpm_backend_query_tpm(TPMBackend *s);
|
|
|
|
|
2013-04-02 18:28:41 +02:00
|
|
|
TPMBackend *qemu_find_tpm(const char *id);
|
|
|
|
|
2017-08-24 10:45:59 +02:00
|
|
|
void tpm_register_model(enum TpmModel model);
|
2013-04-02 18:28:41 +02:00
|
|
|
|
2013-03-28 12:26:21 +01:00
|
|
|
#endif
|