xref: /openbmc/qemu/hw/tpm/tpm_tis.h (revision ed5abf46)
1 /*
2  * tpm_tis.h - QEMU's TPM TIS common header
3  *
4  * Copyright (C) 2006,2010-2013 IBM Corporation
5  *
6  * Authors:
7  *  Stefan Berger <stefanb@us.ibm.com>
8  *  David Safford <safford@us.ibm.com>
9  *
10  * Xen 4 support: Andrease Niederl <andreas.niederl@iaik.tugraz.at>
11  *
12  * This work is licensed under the terms of the GNU GPL, version 2 or later.
13  * See the COPYING file in the top-level directory.
14  *
15  * Implementation of the TIS interface according to specs found at
16  * http://www.trustedcomputinggroup.org. This implementation currently
17  * supports version 1.3, 21 March 2013
18  * In the developers menu choose the PC Client section then find the TIS
19  * specification.
20  *
21  * TPM TIS for TPM 2 implementation following TCG PC Client Platform
22  * TPM Profile (PTP) Specification, Familiy 2.0, Revision 00.43
23  */
24 #ifndef TPM_TPM_TIS_H
25 #define TPM_TPM_TIS_H
26 
27 #include "qemu/osdep.h"
28 #include "sysemu/tpm_backend.h"
29 #include "tpm_ppi.h"
30 
31 #define TPM_TIS_NUM_LOCALITIES      5     /* per spec */
32 #define TPM_TIS_LOCALITY_SHIFT      12
33 #define TPM_TIS_NO_LOCALITY         0xff
34 
35 #define TPM_TIS_IS_VALID_LOCTY(x)   ((x) < TPM_TIS_NUM_LOCALITIES)
36 
37 #define TPM_TIS_BUFFER_MAX          4096
38 
39 typedef enum {
40     TPM_TIS_STATE_IDLE = 0,
41     TPM_TIS_STATE_READY,
42     TPM_TIS_STATE_COMPLETION,
43     TPM_TIS_STATE_EXECUTION,
44     TPM_TIS_STATE_RECEPTION,
45 } TPMTISState;
46 
47 /* locality data  -- all fields are persisted */
48 typedef struct TPMLocality {
49     TPMTISState state;
50     uint8_t access;
51     uint32_t sts;
52     uint32_t iface_id;
53     uint32_t inte;
54     uint32_t ints;
55 } TPMLocality;
56 
57 typedef struct TPMState {
58     MemoryRegion mmio;
59 
60     unsigned char buffer[TPM_TIS_BUFFER_MAX];
61     uint16_t rw_offset;
62 
63     uint8_t active_locty;
64     uint8_t aborting_locty;
65     uint8_t next_locty;
66 
67     TPMLocality loc[TPM_TIS_NUM_LOCALITIES];
68 
69     qemu_irq irq;
70     uint32_t irq_num;
71 
72     TPMBackendCmd cmd;
73 
74     TPMBackend *be_driver;
75     TPMVersion be_tpm_version;
76 
77     size_t be_buffer_size;
78 
79     bool ppi_enabled;
80     TPMPPI ppi;
81 } TPMState;
82 
83 extern const VMStateDescription vmstate_locty;
84 extern const MemoryRegionOps tpm_tis_memory_ops;
85 
86 int tpm_tis_pre_save(TPMState *s);
87 void tpm_tis_reset(TPMState *s);
88 enum TPMVersion tpm_tis_get_tpm_version(TPMState *s);
89 void tpm_tis_request_completed(TPMState *s, int ret);
90 
91 #endif /* TPM_TPM_TIS_H */
92