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