xref: /openbmc/qemu/hw/tpm/tpm_tis_isa.c (revision ad9e5aa2)
1 /*
2  * tpm_tis_isa.c - QEMU's TPM TIS ISA Device
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 
25 #include "qemu/osdep.h"
26 #include "hw/isa/isa.h"
27 #include "hw/qdev-properties.h"
28 #include "migration/vmstate.h"
29 #include "hw/acpi/tpm.h"
30 #include "tpm_prop.h"
31 #include "tpm_tis.h"
32 
33 typedef struct TPMStateISA {
34     /*< private >*/
35     ISADevice parent_obj;
36 
37     /*< public >*/
38     TPMState state; /* not a QOM object */
39 } TPMStateISA;
40 
41 #define TPM_TIS_ISA(obj) OBJECT_CHECK(TPMStateISA, (obj), TYPE_TPM_TIS_ISA)
42 
43 static int tpm_tis_pre_save_isa(void *opaque)
44 {
45     TPMStateISA *isadev = opaque;
46 
47     return tpm_tis_pre_save(&isadev->state);
48 }
49 
50 static const VMStateDescription vmstate_tpm_tis_isa = {
51     .name = "tpm-tis",
52     .version_id = 0,
53     .pre_save  = tpm_tis_pre_save_isa,
54     .fields = (VMStateField[]) {
55         VMSTATE_BUFFER(state.buffer, TPMStateISA),
56         VMSTATE_UINT16(state.rw_offset, TPMStateISA),
57         VMSTATE_UINT8(state.active_locty, TPMStateISA),
58         VMSTATE_UINT8(state.aborting_locty, TPMStateISA),
59         VMSTATE_UINT8(state.next_locty, TPMStateISA),
60 
61         VMSTATE_STRUCT_ARRAY(state.loc, TPMStateISA, TPM_TIS_NUM_LOCALITIES, 0,
62                              vmstate_locty, TPMLocality),
63 
64         VMSTATE_END_OF_LIST()
65     }
66 };
67 
68 static void tpm_tis_isa_request_completed(TPMIf *ti, int ret)
69 {
70     TPMStateISA *isadev = TPM_TIS_ISA(ti);
71     TPMState *s = &isadev->state;
72 
73     tpm_tis_request_completed(s, ret);
74 }
75 
76 static enum TPMVersion tpm_tis_isa_get_tpm_version(TPMIf *ti)
77 {
78     TPMStateISA *isadev = TPM_TIS_ISA(ti);
79     TPMState *s = &isadev->state;
80 
81     return tpm_tis_get_tpm_version(s);
82 }
83 
84 static void tpm_tis_isa_reset(DeviceState *dev)
85 {
86     TPMStateISA *isadev = TPM_TIS_ISA(dev);
87     TPMState *s = &isadev->state;
88 
89     return tpm_tis_reset(s);
90 }
91 
92 static Property tpm_tis_isa_properties[] = {
93     DEFINE_PROP_UINT32("irq", TPMStateISA, state.irq_num, TPM_TIS_IRQ),
94     DEFINE_PROP_TPMBE("tpmdev", TPMStateISA, state.be_driver),
95     DEFINE_PROP_BOOL("ppi", TPMStateISA, state.ppi_enabled, true),
96     DEFINE_PROP_END_OF_LIST(),
97 };
98 
99 static void tpm_tis_isa_initfn(Object *obj)
100 {
101     TPMStateISA *isadev = TPM_TIS_ISA(obj);
102     TPMState *s = &isadev->state;
103 
104     memory_region_init_io(&s->mmio, obj, &tpm_tis_memory_ops,
105                           s, "tpm-tis-mmio",
106                           TPM_TIS_NUM_LOCALITIES << TPM_TIS_LOCALITY_SHIFT);
107 }
108 
109 static void tpm_tis_isa_realizefn(DeviceState *dev, Error **errp)
110 {
111     TPMStateISA *isadev = TPM_TIS_ISA(dev);
112     TPMState *s = &isadev->state;
113 
114     if (!tpm_find()) {
115         error_setg(errp, "at most one TPM device is permitted");
116         return;
117     }
118 
119     if (!s->be_driver) {
120         error_setg(errp, "'tpmdev' property is required");
121         return;
122     }
123     if (s->irq_num > 15) {
124         error_setg(errp, "IRQ %d is outside valid range of 0 to 15",
125                    s->irq_num);
126         return;
127     }
128 
129     isa_init_irq(ISA_DEVICE(dev), &s->irq, s->irq_num);
130 
131     memory_region_add_subregion(isa_address_space(ISA_DEVICE(dev)),
132                                 TPM_TIS_ADDR_BASE, &s->mmio);
133 
134     if (s->ppi_enabled) {
135         tpm_ppi_init(&s->ppi, isa_address_space(ISA_DEVICE(dev)),
136                      TPM_PPI_ADDR_BASE, OBJECT(dev));
137     }
138 }
139 
140 static void tpm_tis_isa_class_init(ObjectClass *klass, void *data)
141 {
142     DeviceClass *dc = DEVICE_CLASS(klass);
143     TPMIfClass *tc = TPM_IF_CLASS(klass);
144 
145     device_class_set_props(dc, tpm_tis_isa_properties);
146     dc->vmsd  = &vmstate_tpm_tis_isa;
147     tc->model = TPM_MODEL_TPM_TIS;
148     dc->realize = tpm_tis_isa_realizefn;
149     dc->reset = tpm_tis_isa_reset;
150     tc->request_completed = tpm_tis_isa_request_completed;
151     tc->get_version = tpm_tis_isa_get_tpm_version;
152 }
153 
154 static const TypeInfo tpm_tis_isa_info = {
155     .name = TYPE_TPM_TIS_ISA,
156     .parent = TYPE_ISA_DEVICE,
157     .instance_size = sizeof(TPMStateISA),
158     .instance_init = tpm_tis_isa_initfn,
159     .class_init  = tpm_tis_isa_class_init,
160     .interfaces = (InterfaceInfo[]) {
161         { TYPE_TPM_IF },
162         { }
163     }
164 };
165 
166 static void tpm_tis_isa_register(void)
167 {
168     type_register_static(&tpm_tis_isa_info);
169 }
170 
171 type_init(tpm_tis_isa_register)
172