xref: /qemu/hw/tpm/tpm_tis_sysbus.c (revision db1015e92e04835c9eb50c29625fe566d1202dbd)
1 /*
2  * tpm_tis_sysbus.c - QEMU's TPM TIS SYSBUS 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/qdev-properties.h"
27 #include "migration/vmstate.h"
28 #include "hw/acpi/tpm.h"
29 #include "tpm_prop.h"
30 #include "hw/sysbus.h"
31 #include "tpm_tis.h"
32 #include "qom/object.h"
33 
34 struct TPMStateSysBus {
35     /*< private >*/
36     SysBusDevice parent_obj;
37 
38     /*< public >*/
39     TPMState state; /* not a QOM object */
40 };
41 typedef struct TPMStateSysBus TPMStateSysBus;
42 
43 #define TPM_TIS_SYSBUS(obj) OBJECT_CHECK(TPMStateSysBus, (obj), TYPE_TPM_TIS_SYSBUS)
44 
45 static int tpm_tis_pre_save_sysbus(void *opaque)
46 {
47     TPMStateSysBus *sbdev = opaque;
48 
49     return tpm_tis_pre_save(&sbdev->state);
50 }
51 
52 static const VMStateDescription vmstate_tpm_tis_sysbus = {
53     .name = "tpm-tis",
54     .version_id = 0,
55     .pre_save  = tpm_tis_pre_save_sysbus,
56     .fields = (VMStateField[]) {
57         VMSTATE_BUFFER(state.buffer, TPMStateSysBus),
58         VMSTATE_UINT16(state.rw_offset, TPMStateSysBus),
59         VMSTATE_UINT8(state.active_locty, TPMStateSysBus),
60         VMSTATE_UINT8(state.aborting_locty, TPMStateSysBus),
61         VMSTATE_UINT8(state.next_locty, TPMStateSysBus),
62 
63         VMSTATE_STRUCT_ARRAY(state.loc, TPMStateSysBus, TPM_TIS_NUM_LOCALITIES,
64                              0, vmstate_locty, TPMLocality),
65 
66         VMSTATE_END_OF_LIST()
67     }
68 };
69 
70 static void tpm_tis_sysbus_request_completed(TPMIf *ti, int ret)
71 {
72     TPMStateSysBus *sbdev = TPM_TIS_SYSBUS(ti);
73     TPMState *s = &sbdev->state;
74 
75     tpm_tis_request_completed(s, ret);
76 }
77 
78 static enum TPMVersion tpm_tis_sysbus_get_tpm_version(TPMIf *ti)
79 {
80     TPMStateSysBus *sbdev = TPM_TIS_SYSBUS(ti);
81     TPMState *s = &sbdev->state;
82 
83     return tpm_tis_get_tpm_version(s);
84 }
85 
86 static void tpm_tis_sysbus_reset(DeviceState *dev)
87 {
88     TPMStateSysBus *sbdev = TPM_TIS_SYSBUS(dev);
89     TPMState *s = &sbdev->state;
90 
91     return tpm_tis_reset(s);
92 }
93 
94 static Property tpm_tis_sysbus_properties[] = {
95     DEFINE_PROP_UINT32("irq", TPMStateSysBus, state.irq_num, TPM_TIS_IRQ),
96     DEFINE_PROP_TPMBE("tpmdev", TPMStateSysBus, state.be_driver),
97     DEFINE_PROP_BOOL("ppi", TPMStateSysBus, state.ppi_enabled, false),
98     DEFINE_PROP_END_OF_LIST(),
99 };
100 
101 static void tpm_tis_sysbus_initfn(Object *obj)
102 {
103     TPMStateSysBus *sbdev = TPM_TIS_SYSBUS(obj);
104     TPMState *s = &sbdev->state;
105 
106     memory_region_init_io(&s->mmio, obj, &tpm_tis_memory_ops,
107                           s, "tpm-tis-mmio",
108                           TPM_TIS_NUM_LOCALITIES << TPM_TIS_LOCALITY_SHIFT);
109 
110     sysbus_init_mmio(SYS_BUS_DEVICE(obj), &s->mmio);
111     sysbus_init_irq(SYS_BUS_DEVICE(obj), &s->irq);
112 }
113 
114 static void tpm_tis_sysbus_realizefn(DeviceState *dev, Error **errp)
115 {
116     TPMStateSysBus *sbdev = TPM_TIS_SYSBUS(dev);
117     TPMState *s = &sbdev->state;
118 
119     if (!tpm_find()) {
120         error_setg(errp, "at most one TPM device is permitted");
121         return;
122     }
123 
124     if (!s->be_driver) {
125         error_setg(errp, "'tpmdev' property is required");
126         return;
127     }
128 }
129 
130 static void tpm_tis_sysbus_class_init(ObjectClass *klass, void *data)
131 {
132     DeviceClass *dc = DEVICE_CLASS(klass);
133     TPMIfClass *tc = TPM_IF_CLASS(klass);
134 
135     device_class_set_props(dc, tpm_tis_sysbus_properties);
136     dc->vmsd  = &vmstate_tpm_tis_sysbus;
137     tc->model = TPM_MODEL_TPM_TIS;
138     dc->realize = tpm_tis_sysbus_realizefn;
139     dc->user_creatable = true;
140     dc->reset = tpm_tis_sysbus_reset;
141     tc->request_completed = tpm_tis_sysbus_request_completed;
142     tc->get_version = tpm_tis_sysbus_get_tpm_version;
143 }
144 
145 static const TypeInfo tpm_tis_sysbus_info = {
146     .name = TYPE_TPM_TIS_SYSBUS,
147     .parent = TYPE_SYS_BUS_DEVICE,
148     .instance_size = sizeof(TPMStateSysBus),
149     .instance_init = tpm_tis_sysbus_initfn,
150     .class_init  = tpm_tis_sysbus_class_init,
151     .interfaces = (InterfaceInfo[]) {
152         { TYPE_TPM_IF },
153         { }
154     }
155 };
156 
157 static void tpm_tis_sysbus_register(void)
158 {
159     type_register_static(&tpm_tis_sysbus_info);
160 }
161 
162 type_init(tpm_tis_sysbus_register)
163