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 */ 69 int (*startup_tpm)(TPMBackend *t); 70 71 void (*reset)(TPMBackend *t); 72 73 void (*cancel_cmd)(TPMBackend *t); 74 75 bool (*get_tpm_established_flag)(TPMBackend *t); 76 77 int (*reset_tpm_established_flag)(TPMBackend *t, uint8_t locty); 78 79 TPMVersion (*get_tpm_version)(TPMBackend *t); 80 81 TpmTypeOptions *(*get_tpm_options)(TPMBackend *t); 82 83 void (*handle_request)(TPMBackend *s, TPMBackendCmd *cmd); 84 }; 85 86 /** 87 * tpm_backend_get_type: 88 * @s: the backend 89 * 90 * Returns the TpmType of the backend. 91 */ 92 enum TpmType tpm_backend_get_type(TPMBackend *s); 93 94 /** 95 * tpm_backend_init: 96 * @s: the backend to initialized 97 * @tpmif: TPM interface 98 * @datacb: callback for sending data to frontend 99 * @errp: a pointer to return the #Error object if an error occurs. 100 * 101 * Initialize the backend with the given variables. 102 * 103 * Returns 0 on success. 104 */ 105 int tpm_backend_init(TPMBackend *s, TPMIf *tpmif, Error **errp); 106 107 /** 108 * tpm_backend_startup_tpm: 109 * @s: the backend whose TPM support is to be started 110 * 111 * Returns 0 on success. 112 */ 113 int tpm_backend_startup_tpm(TPMBackend *s); 114 115 /** 116 * tpm_backend_had_startup_error: 117 * @s: the backend to query for a statup error 118 * 119 * Check whether the backend had an error during startup. Returns 120 * false if no error occurred and the backend can be used, true 121 * otherwise. 122 */ 123 bool tpm_backend_had_startup_error(TPMBackend *s); 124 125 /** 126 * tpm_backend_deliver_request: 127 * @s: the backend to send the request to 128 * @cmd: the command to deliver 129 * 130 * Send a request to the backend. The backend will then send the request 131 * to the TPM implementation. 132 */ 133 void tpm_backend_deliver_request(TPMBackend *s, TPMBackendCmd *cmd); 134 135 /** 136 * tpm_backend_reset: 137 * @s: the backend to reset 138 * 139 * Reset the backend into a well defined state with all previous errors 140 * reset. 141 */ 142 void tpm_backend_reset(TPMBackend *s); 143 144 /** 145 * tpm_backend_cancel_cmd: 146 * @s: the backend 147 * 148 * Cancel any ongoing command being processed by the TPM implementation 149 * on behalf of the QEMU guest. 150 */ 151 void tpm_backend_cancel_cmd(TPMBackend *s); 152 153 /** 154 * tpm_backend_get_tpm_established_flag: 155 * @s: the backend 156 * 157 * Get the TPM establishment flag. This function may be called very 158 * frequently by the frontend since for example in the TIS implementation 159 * this flag is part of a register. 160 */ 161 bool tpm_backend_get_tpm_established_flag(TPMBackend *s); 162 163 /** 164 * tpm_backend_reset_tpm_established_flag: 165 * @s: the backend 166 * @locty: the locality number 167 * 168 * Reset the TPM establishment flag. 169 */ 170 int tpm_backend_reset_tpm_established_flag(TPMBackend *s, uint8_t locty); 171 172 /** 173 * tpm_backend_get_tpm_version: 174 * @s: the backend to call into 175 * 176 * Get the TPM Version that is emulated at the backend. 177 * 178 * Returns TPMVersion. 179 */ 180 TPMVersion tpm_backend_get_tpm_version(TPMBackend *s); 181 182 /** 183 * tpm_backend_query_tpm: 184 * @s: the backend 185 * 186 * Query backend tpm info 187 * 188 * Returns newly allocated TPMInfo 189 */ 190 TPMInfo *tpm_backend_query_tpm(TPMBackend *s); 191 192 TPMBackend *qemu_find_tpm(const char *id); 193 194 void tpm_register_model(enum TpmModel model); 195 196 #endif 197