1 /*
2 * QEMU ISA IPMI KCS emulation
3 *
4 * Copyright (c) 2015,2017 Corey Minyard, MontaVista Software, LLC
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25 #include "qemu/osdep.h"
26 #include "qemu/module.h"
27 #include "qapi/error.h"
28 #include "hw/irq.h"
29 #include "hw/ipmi/ipmi_kcs.h"
30 #include "hw/isa/isa.h"
31 #include "hw/qdev-properties.h"
32 #include "migration/vmstate.h"
33 #include "qom/object.h"
34 #include "hw/acpi/ipmi.h"
35
36 #define TYPE_ISA_IPMI_KCS "isa-ipmi-kcs"
37 OBJECT_DECLARE_SIMPLE_TYPE(ISAIPMIKCSDevice, ISA_IPMI_KCS)
38
39 struct ISAIPMIKCSDevice {
40 ISADevice dev;
41 int32_t isairq;
42 qemu_irq irq;
43 IPMIKCS kcs;
44 uint32_t uuid;
45 };
46
isa_ipmi_kcs_get_fwinfo(IPMIInterface * ii,IPMIFwInfo * info)47 static void isa_ipmi_kcs_get_fwinfo(IPMIInterface *ii, IPMIFwInfo *info)
48 {
49 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(ii);
50
51 ipmi_kcs_get_fwinfo(&iik->kcs, info);
52 info->irq_source = IPMI_ISA_IRQ;
53 info->interrupt_number = iik->isairq;
54 info->uuid = iik->uuid;
55 }
56
isa_ipmi_kcs_raise_irq(IPMIKCS * ik)57 static void isa_ipmi_kcs_raise_irq(IPMIKCS *ik)
58 {
59 ISAIPMIKCSDevice *iik = ik->opaque;
60
61 qemu_irq_raise(iik->irq);
62 }
63
isa_ipmi_kcs_lower_irq(IPMIKCS * ik)64 static void isa_ipmi_kcs_lower_irq(IPMIKCS *ik)
65 {
66 ISAIPMIKCSDevice *iik = ik->opaque;
67
68 qemu_irq_lower(iik->irq);
69 }
70
vmstate_kcs_before_version2(void * opaque,int version)71 static bool vmstate_kcs_before_version2(void *opaque, int version)
72 {
73 return version <= 1;
74 }
75
76 /*
77 * Version 1 had an incorrect name, it clashed with the BT IPMI
78 * device, so receive it, but transmit a different version.
79 */
80 static const VMStateDescription vmstate_ISAIPMIKCSDevice = {
81 .name = TYPE_IPMI_INTERFACE,
82 .version_id = 2,
83 .minimum_version_id = 1,
84 .fields = (const VMStateField[]) {
85 VMSTATE_VSTRUCT_TEST(kcs, ISAIPMIKCSDevice, vmstate_kcs_before_version2,
86 0, vmstate_IPMIKCS, IPMIKCS, 1),
87 VMSTATE_VSTRUCT_V(kcs, ISAIPMIKCSDevice, 2, vmstate_IPMIKCS,
88 IPMIKCS, 2),
89 VMSTATE_END_OF_LIST()
90 }
91 };
92
ipmi_isa_realize(DeviceState * dev,Error ** errp)93 static void ipmi_isa_realize(DeviceState *dev, Error **errp)
94 {
95 Error *err = NULL;
96 ISADevice *isadev = ISA_DEVICE(dev);
97 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(dev);
98 IPMIInterface *ii = IPMI_INTERFACE(dev);
99 IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
100
101 if (!iik->kcs.bmc) {
102 error_setg(errp, "IPMI device requires a bmc attribute to be set");
103 return;
104 }
105
106 iik->uuid = ipmi_next_uuid();
107
108 iik->kcs.bmc->intf = ii;
109 iik->kcs.opaque = iik;
110
111 iic->init(ii, 0, &err);
112 if (err) {
113 error_propagate(errp, err);
114 return;
115 }
116
117 if (iik->isairq > 0) {
118 iik->irq = isa_get_irq(isadev, iik->isairq);
119 iik->kcs.use_irq = 1;
120 iik->kcs.raise_irq = isa_ipmi_kcs_raise_irq;
121 iik->kcs.lower_irq = isa_ipmi_kcs_lower_irq;
122 }
123
124 qdev_set_legacy_instance_id(dev, iik->kcs.io_base, iik->kcs.io_length);
125
126 isa_register_ioport(isadev, &iik->kcs.io, iik->kcs.io_base);
127 }
128
isa_ipmi_kcs_init(Object * obj)129 static void isa_ipmi_kcs_init(Object *obj)
130 {
131 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(obj);
132
133 ipmi_bmc_find_and_link(obj, (Object **) &iik->kcs.bmc);
134 }
135
isa_ipmi_kcs_get_backend_data(IPMIInterface * ii)136 static void *isa_ipmi_kcs_get_backend_data(IPMIInterface *ii)
137 {
138 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(ii);
139
140 return &iik->kcs;
141 }
142
143 static const Property ipmi_isa_properties[] = {
144 DEFINE_PROP_UINT32("ioport", ISAIPMIKCSDevice, kcs.io_base, 0xca2),
145 DEFINE_PROP_INT32("irq", ISAIPMIKCSDevice, isairq, 5),
146 };
147
isa_ipmi_kcs_class_init(ObjectClass * oc,const void * data)148 static void isa_ipmi_kcs_class_init(ObjectClass *oc, const void *data)
149 {
150 DeviceClass *dc = DEVICE_CLASS(oc);
151 IPMIInterfaceClass *iic = IPMI_INTERFACE_CLASS(oc);
152 AcpiDevAmlIfClass *adevc = ACPI_DEV_AML_IF_CLASS(oc);
153
154 dc->realize = ipmi_isa_realize;
155 dc->vmsd = &vmstate_ISAIPMIKCSDevice;
156 device_class_set_props(dc, ipmi_isa_properties);
157
158 iic->get_backend_data = isa_ipmi_kcs_get_backend_data;
159 ipmi_kcs_class_init(iic);
160 iic->get_fwinfo = isa_ipmi_kcs_get_fwinfo;
161 adevc->build_dev_aml = build_ipmi_dev_aml;
162 }
163
164 static const TypeInfo isa_ipmi_kcs_info = {
165 .name = TYPE_ISA_IPMI_KCS,
166 .parent = TYPE_ISA_DEVICE,
167 .instance_size = sizeof(ISAIPMIKCSDevice),
168 .instance_init = isa_ipmi_kcs_init,
169 .class_init = isa_ipmi_kcs_class_init,
170 .interfaces = (const InterfaceInfo[]) {
171 { TYPE_IPMI_INTERFACE },
172 { TYPE_ACPI_DEV_AML_IF },
173 { }
174 }
175 };
176
ipmi_register_types(void)177 static void ipmi_register_types(void)
178 {
179 type_register_static(&isa_ipmi_kcs_info);
180 }
181
182 type_init(ipmi_register_types)
183