blob: f52b32e590b9a35838ab25577755b9ddb50aa861 [file] [log] [blame]
Corey Minyard07190292015-12-17 12:50:07 -06001/*
2 * QEMU ISA IPMI KCS emulation
3 *
Corey Minyard0f310cd2017-12-06 07:34:24 -06004 * Copyright (c) 2015,2017 Corey Minyard, MontaVista Software, LLC
Corey Minyard07190292015-12-17 12:50:07 -06005 *
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 */
Markus Armbruster0b8fa322019-05-23 16:35:07 +020024
Peter Maydell04308912016-01-26 18:17:30 +000025#include "qemu/osdep.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020026#include "qemu/module.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010027#include "qapi/error.h"
Markus Armbruster64552b62019-08-12 07:23:42 +020028#include "hw/irq.h"
Corey Minyard0f310cd2017-12-06 07:34:24 -060029#include "hw/ipmi/ipmi_kcs.h"
Corey Minyard07190292015-12-17 12:50:07 -060030#include "hw/isa/isa.h"
Markus Armbrustera27bd6c2019-08-12 07:23:51 +020031#include "hw/qdev-properties.h"
Markus Armbrusterd6454272019-08-12 07:23:45 +020032#include "migration/vmstate.h"
Eduardo Habkostdb1015e2020-09-03 16:43:22 -040033#include "qom/object.h"
Igor Mammedov5876d9b2022-06-08 09:53:21 -040034#include "hw/acpi/ipmi.h"
Corey Minyard07190292015-12-17 12:50:07 -060035
Corey Minyard07190292015-12-17 12:50:07 -060036#define TYPE_ISA_IPMI_KCS "isa-ipmi-kcs"
Eduardo Habkost80633962020-09-16 14:25:19 -040037OBJECT_DECLARE_SIMPLE_TYPE(ISAIPMIKCSDevice, ISA_IPMI_KCS)
Corey Minyard07190292015-12-17 12:50:07 -060038
Eduardo Habkostdb1015e2020-09-03 16:43:22 -040039struct ISAIPMIKCSDevice {
Corey Minyard07190292015-12-17 12:50:07 -060040 ISADevice dev;
Peter Maydellf4014512016-01-22 15:09:21 +000041 int32_t isairq;
Corey Minyard0f310cd2017-12-06 07:34:24 -060042 qemu_irq irq;
Corey Minyard07190292015-12-17 12:50:07 -060043 IPMIKCS kcs;
Corey Minyard15139b82016-05-24 12:37:17 -050044 uint32_t uuid;
Eduardo Habkostdb1015e2020-09-03 16:43:22 -040045};
Corey Minyard07190292015-12-17 12:50:07 -060046
Corey Minyard0f310cd2017-12-06 07:34:24 -060047static void isa_ipmi_kcs_get_fwinfo(IPMIInterface *ii, IPMIFwInfo *info)
Corey Minyard15139b82016-05-24 12:37:17 -050048{
49 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(ii);
50
Corey Minyard0f310cd2017-12-06 07:34:24 -060051 ipmi_kcs_get_fwinfo(&iik->kcs, info);
Corey Minyard15139b82016-05-24 12:37:17 -050052 info->interrupt_number = iik->isairq;
53 info->uuid = iik->uuid;
54}
55
Corey Minyard0f310cd2017-12-06 07:34:24 -060056static void isa_ipmi_kcs_raise_irq(IPMIKCS *ik)
Corey Minyard15139b82016-05-24 12:37:17 -050057{
Corey Minyard0f310cd2017-12-06 07:34:24 -060058 ISAIPMIKCSDevice *iik = ik->opaque;
59
60 qemu_irq_raise(iik->irq);
61}
62
63static void isa_ipmi_kcs_lower_irq(IPMIKCS *ik)
64{
65 ISAIPMIKCSDevice *iik = ik->opaque;
66
67 qemu_irq_lower(iik->irq);
Corey Minyard15139b82016-05-24 12:37:17 -050068}
69
Thomas Huth6436db52023-10-20 16:55:54 +020070static bool vmstate_kcs_before_version2(void *opaque, int version)
71{
72 return version <= 1;
73}
74
75static const VMStateDescription vmstate_ISAIPMIKCSDevice = {
76 .name = TYPE_IPMI_INTERFACE,
77 .version_id = 2,
78 .minimum_version_id = 1,
Richard Henderson09c6ac62023-12-21 14:16:17 +110079 .fields = (const VMStateField[]) {
Thomas Huth6436db52023-10-20 16:55:54 +020080 VMSTATE_VSTRUCT_TEST(kcs, ISAIPMIKCSDevice, vmstate_kcs_before_version2,
81 0, vmstate_IPMIKCS, IPMIKCS, 1),
82 VMSTATE_VSTRUCT_V(kcs, ISAIPMIKCSDevice, 2, vmstate_IPMIKCS,
83 IPMIKCS, 2),
84 VMSTATE_END_OF_LIST()
85 }
86};
87
Corey Minyard07190292015-12-17 12:50:07 -060088static void ipmi_isa_realize(DeviceState *dev, Error **errp)
89{
Markus Armbrusterf6166a42019-12-04 10:36:15 +010090 Error *err = NULL;
Corey Minyard07190292015-12-17 12:50:07 -060091 ISADevice *isadev = ISA_DEVICE(dev);
92 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(dev);
93 IPMIInterface *ii = IPMI_INTERFACE(dev);
94 IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
95
96 if (!iik->kcs.bmc) {
97 error_setg(errp, "IPMI device requires a bmc attribute to be set");
98 return;
99 }
100
Corey Minyard15139b82016-05-24 12:37:17 -0500101 iik->uuid = ipmi_next_uuid();
102
Corey Minyard07190292015-12-17 12:50:07 -0600103 iik->kcs.bmc->intf = ii;
Corey Minyard0f310cd2017-12-06 07:34:24 -0600104 iik->kcs.opaque = iik;
Corey Minyard07190292015-12-17 12:50:07 -0600105
Markus Armbrusterf6166a42019-12-04 10:36:15 +0100106 iic->init(ii, 0, &err);
107 if (err) {
108 error_propagate(errp, err);
Corey Minyard07190292015-12-17 12:50:07 -0600109 return;
Markus Armbrusterf6166a42019-12-04 10:36:15 +0100110 }
Corey Minyard07190292015-12-17 12:50:07 -0600111
112 if (iik->isairq > 0) {
Bernhard Beschow215caca2022-03-01 23:00:37 +0100113 iik->irq = isa_get_irq(isadev, iik->isairq);
Corey Minyard07190292015-12-17 12:50:07 -0600114 iik->kcs.use_irq = 1;
Corey Minyard0f310cd2017-12-06 07:34:24 -0600115 iik->kcs.raise_irq = isa_ipmi_kcs_raise_irq;
116 iik->kcs.lower_irq = isa_ipmi_kcs_lower_irq;
Corey Minyard07190292015-12-17 12:50:07 -0600117 }
118
119 qdev_set_legacy_instance_id(dev, iik->kcs.io_base, iik->kcs.io_length);
120
121 isa_register_ioport(isadev, &iik->kcs.io, iik->kcs.io_base);
Corey Minyardbd66bcf2015-12-17 12:50:11 -0600122
Corey Minyard7e57b822018-04-25 10:27:31 -0500123 /*
124 * Version 1 had an incorrect name, it clashed with the BT
125 * IPMI device, so receive it, but transmit a different
126 * version.
127 */
Corey Minyardbd66bcf2015-12-17 12:50:11 -0600128 vmstate_register(NULL, 0, &vmstate_ISAIPMIKCSDevice, iik);
Corey Minyard07190292015-12-17 12:50:07 -0600129}
130
Thomas Huth6436db52023-10-20 16:55:54 +0200131static void isa_ipmi_kcs_init(Object *obj)
132{
133 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(obj);
134
135 ipmi_bmc_find_and_link(obj, (Object **) &iik->kcs.bmc);
136}
137
Corey Minyard07190292015-12-17 12:50:07 -0600138static void *isa_ipmi_kcs_get_backend_data(IPMIInterface *ii)
139{
140 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(ii);
141
142 return &iik->kcs;
143}
144
145static Property ipmi_isa_properties[] = {
146 DEFINE_PROP_UINT32("ioport", ISAIPMIKCSDevice, kcs.io_base, 0xca2),
147 DEFINE_PROP_INT32("irq", ISAIPMIKCSDevice, isairq, 5),
148 DEFINE_PROP_END_OF_LIST(),
149};
150
151static void isa_ipmi_kcs_class_init(ObjectClass *oc, void *data)
152{
153 DeviceClass *dc = DEVICE_CLASS(oc);
154 IPMIInterfaceClass *iic = IPMI_INTERFACE_CLASS(oc);
Igor Mammedov5876d9b2022-06-08 09:53:21 -0400155 AcpiDevAmlIfClass *adevc = ACPI_DEV_AML_IF_CLASS(oc);
Corey Minyard07190292015-12-17 12:50:07 -0600156
157 dc->realize = ipmi_isa_realize;
Marc-André Lureau4f67d302020-01-10 19:30:32 +0400158 device_class_set_props(dc, ipmi_isa_properties);
Corey Minyard07190292015-12-17 12:50:07 -0600159
160 iic->get_backend_data = isa_ipmi_kcs_get_backend_data;
161 ipmi_kcs_class_init(iic);
Corey Minyard0f310cd2017-12-06 07:34:24 -0600162 iic->get_fwinfo = isa_ipmi_kcs_get_fwinfo;
Igor Mammedov5876d9b2022-06-08 09:53:21 -0400163 adevc->build_dev_aml = build_ipmi_dev_aml;
Corey Minyard07190292015-12-17 12:50:07 -0600164}
165
166static const TypeInfo isa_ipmi_kcs_info = {
167 .name = TYPE_ISA_IPMI_KCS,
168 .parent = TYPE_ISA_DEVICE,
169 .instance_size = sizeof(ISAIPMIKCSDevice),
170 .instance_init = isa_ipmi_kcs_init,
171 .class_init = isa_ipmi_kcs_class_init,
172 .interfaces = (InterfaceInfo[]) {
173 { TYPE_IPMI_INTERFACE },
Igor Mammedov5876d9b2022-06-08 09:53:21 -0400174 { TYPE_ACPI_DEV_AML_IF },
Corey Minyard07190292015-12-17 12:50:07 -0600175 { }
176 }
177};
178
179static void ipmi_register_types(void)
180{
181 type_register_static(&isa_ipmi_kcs_info);
182}
183
184type_init(ipmi_register_types)