1 /* 2 * QEMU TPM Backend 3 * 4 * Copyright IBM, Corp. 2013 5 * 6 * Authors: 7 * Stefan Berger <stefanb@us.ibm.com> 8 * 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. 11 */ 12 13 #ifndef TPM_BACKEND_H 14 #define TPM_BACKEND_H 15 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 22 #define TYPE_TPM_BACKEND "tpm-backend" 23 #define TPM_BACKEND(obj) \ 24 OBJECT_CHECK(TPMBackend, (obj), TYPE_TPM_BACKEND) 25 #define TPM_BACKEND_GET_CLASS(obj) \ 26 OBJECT_GET_CLASS(TPMBackendClass, (obj), TYPE_TPM_BACKEND) 27 #define TPM_BACKEND_CLASS(klass) \ 28 OBJECT_CLASS_CHECK(TPMBackendClass, (klass), TYPE_TPM_BACKEND) 29 30 typedef struct TPMBackendClass TPMBackendClass; 31 typedef struct TPMBackend TPMBackend; 32 33 typedef struct TPMBackendCmd { 34 uint8_t locty; 35 const uint8_t *in; 36 uint32_t in_len; 37 uint8_t *out; 38 uint32_t out_len; 39 bool selftest_done; 40 } TPMBackendCmd; 41 42 struct TPMBackend { 43 Object parent; 44 45 /*< protected >*/ 46 TPMIf *tpmif; 47 bool opened; 48 GThreadPool *thread_pool; 49 bool had_startup_error; 50 QEMUBH *bh; 51 52 /* <public> */ 53 char *id; 54 55 QLIST_ENTRY(TPMBackend) list; 56 }; 57 58 struct TPMBackendClass { 59 ObjectClass parent_class; 60 61 enum TpmType type; 62 const QemuOptDesc *opts; 63 /* get a descriptive text of the backend to display to the user */ 64 const char *desc; 65 66 TPMBackend *(*create)(QemuOpts *opts, const char *id); 67 68 /* start up the TPM on the backend - optional */ 69 int (*startup_tpm)(TPMBackend *t); 70 71 /* optional */ 72 void (*reset)(TPMBackend *t); 73 74 void (*cancel_cmd)(TPMBackend *t); 75 76 /* optional */ 77 bool (*get_tpm_established_flag)(TPMBackend *t); 78 79 /* optional */ 80 int (*reset_tpm_established_flag)(TPMBackend *t, uint8_t locty); 81 82 TPMVersion (*get_tpm_version)(TPMBackend *t); 83 84 TpmTypeOptions *(*get_tpm_options)(TPMBackend *t); 85 86 void (*handle_request)(TPMBackend *s, TPMBackendCmd *cmd); 87 }; 88 89 /** 90 * tpm_backend_get_type: 91 * @s: the backend 92 * 93 * Returns the TpmType of the backend. 94 */ 95 enum TpmType tpm_backend_get_type(TPMBackend *s); 96 97 /** 98 * tpm_backend_init: 99 * @s: the backend to initialized 100 * @tpmif: TPM interface 101 * @datacb: callback for sending data to frontend 102 * @errp: a pointer to return the #Error object if an error occurs. 103 * 104 * Initialize the backend with the given variables. 105 * 106 * Returns 0 on success. 107 */ 108 int tpm_backend_init(TPMBackend *s, TPMIf *tpmif, Error **errp); 109 110 /** 111 * tpm_backend_startup_tpm: 112 * @s: the backend whose TPM support is to be started 113 * 114 * Returns 0 on success. 115 */ 116 int tpm_backend_startup_tpm(TPMBackend *s); 117 118 /** 119 * tpm_backend_had_startup_error: 120 * @s: the backend to query for a statup error 121 * 122 * Check whether the backend had an error during startup. Returns 123 * false if no error occurred and the backend can be used, true 124 * otherwise. 125 */ 126 bool tpm_backend_had_startup_error(TPMBackend *s); 127 128 /** 129 * tpm_backend_deliver_request: 130 * @s: the backend to send the request to 131 * @cmd: the command to deliver 132 * 133 * Send a request to the backend. The backend will then send the request 134 * to the TPM implementation. 135 */ 136 void tpm_backend_deliver_request(TPMBackend *s, TPMBackendCmd *cmd); 137 138 /** 139 * tpm_backend_reset: 140 * @s: the backend to reset 141 * 142 * Reset the backend into a well defined state with all previous errors 143 * reset. 144 */ 145 void tpm_backend_reset(TPMBackend *s); 146 147 /** 148 * tpm_backend_cancel_cmd: 149 * @s: the backend 150 * 151 * Cancel any ongoing command being processed by the TPM implementation 152 * on behalf of the QEMU guest. 153 */ 154 void tpm_backend_cancel_cmd(TPMBackend *s); 155 156 /** 157 * tpm_backend_get_tpm_established_flag: 158 * @s: the backend 159 * 160 * Get the TPM establishment flag. This function may be called very 161 * frequently by the frontend since for example in the TIS implementation 162 * this flag is part of a register. 163 */ 164 bool tpm_backend_get_tpm_established_flag(TPMBackend *s); 165 166 /** 167 * tpm_backend_reset_tpm_established_flag: 168 * @s: the backend 169 * @locty: the locality number 170 * 171 * Reset the TPM establishment flag. 172 */ 173 int tpm_backend_reset_tpm_established_flag(TPMBackend *s, uint8_t locty); 174 175 /** 176 * tpm_backend_get_tpm_version: 177 * @s: the backend to call into 178 * 179 * Get the TPM Version that is emulated at the backend. 180 * 181 * Returns TPMVersion. 182 */ 183 TPMVersion tpm_backend_get_tpm_version(TPMBackend *s); 184 185 /** 186 * tpm_backend_query_tpm: 187 * @s: the backend 188 * 189 * Query backend tpm info 190 * 191 * Returns newly allocated TPMInfo 192 */ 193 TPMInfo *tpm_backend_query_tpm(TPMBackend *s); 194 195 TPMBackend *qemu_find_tpm(const char *id); 196 197 void tpm_register_model(enum TpmModel model); 198 199 #endif 200