xref: /qemu/hw/ipmi/isa_ipmi_bt.c (revision 06b40d250ecfa1633209c2e431a7a38acfd03a98)
1 /*
2  * QEMU ISA IPMI BT emulation
3  *
4  * Copyright (c) 2015 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_bt.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_BT "isa-ipmi-bt"
37 OBJECT_DECLARE_SIMPLE_TYPE(ISAIPMIBTDevice, ISA_IPMI_BT)
38 
39 struct ISAIPMIBTDevice {
40     ISADevice dev;
41     int32_t isairq;
42     qemu_irq irq;
43     IPMIBT bt;
44     uint32_t uuid;
45 };
46 
isa_ipmi_bt_get_fwinfo(struct IPMIInterface * ii,IPMIFwInfo * info)47 static void isa_ipmi_bt_get_fwinfo(struct IPMIInterface *ii, IPMIFwInfo *info)
48 {
49     ISAIPMIBTDevice *iib = ISA_IPMI_BT(ii);
50 
51     ipmi_bt_get_fwinfo(&iib->bt, info);
52     info->irq_source = IPMI_ISA_IRQ;
53     info->interrupt_number = iib->isairq;
54     info->i2c_slave_address = iib->bt.bmc->slave_addr;
55     info->uuid = iib->uuid;
56 }
57 
isa_ipmi_bt_raise_irq(IPMIBT * ib)58 static void isa_ipmi_bt_raise_irq(IPMIBT *ib)
59 {
60     ISAIPMIBTDevice *iib = ib->opaque;
61 
62     qemu_irq_raise(iib->irq);
63 }
64 
isa_ipmi_bt_lower_irq(IPMIBT * ib)65 static void isa_ipmi_bt_lower_irq(IPMIBT *ib)
66 {
67     ISAIPMIBTDevice *iib = ib->opaque;
68 
69     qemu_irq_lower(iib->irq);
70 }
71 
72 static const VMStateDescription vmstate_ISAIPMIBTDevice = {
73     .name = TYPE_IPMI_INTERFACE_PREFIX "isa-bt",
74     .version_id = 2,
75     .minimum_version_id = 2,
76     /*
77      * Version 1 had messed up the array transfer, it's not even usable
78      * because it used VMSTATE_VBUFFER_UINT32, but it did not transfer
79      * the buffer length, so random things would happen.
80      */
81     .fields = (const VMStateField[]) {
82         VMSTATE_STRUCT(bt, ISAIPMIBTDevice, 1, vmstate_IPMIBT, IPMIBT),
83         VMSTATE_END_OF_LIST()
84     }
85 };
86 
isa_ipmi_bt_realize(DeviceState * dev,Error ** errp)87 static void isa_ipmi_bt_realize(DeviceState *dev, Error **errp)
88 {
89     Error *err = NULL;
90     ISADevice *isadev = ISA_DEVICE(dev);
91     ISAIPMIBTDevice *iib = ISA_IPMI_BT(dev);
92     IPMIInterface *ii = IPMI_INTERFACE(dev);
93     IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
94 
95     if (!iib->bt.bmc) {
96         error_setg(errp, "IPMI device requires a bmc attribute to be set");
97         return;
98     }
99 
100     iib->uuid = ipmi_next_uuid();
101 
102     iib->bt.bmc->intf = ii;
103     iib->bt.opaque = iib;
104 
105     iic->init(ii, 0, &err);
106     if (err) {
107         error_propagate(errp, err);
108         return;
109     }
110 
111     if (iib->isairq > 0) {
112         iib->irq = isa_get_irq(isadev, iib->isairq);
113         iib->bt.use_irq = 1;
114         iib->bt.raise_irq = isa_ipmi_bt_raise_irq;
115         iib->bt.lower_irq = isa_ipmi_bt_lower_irq;
116     }
117 
118     qdev_set_legacy_instance_id(dev, iib->bt.io_base, iib->bt.io_length);
119 
120     isa_register_ioport(isadev, &iib->bt.io, iib->bt.io_base);
121 }
122 
isa_ipmi_bt_init(Object * obj)123 static void isa_ipmi_bt_init(Object *obj)
124 {
125     ISAIPMIBTDevice *iib = ISA_IPMI_BT(obj);
126 
127     ipmi_bmc_find_and_link(obj, (Object **) &iib->bt.bmc);
128 }
129 
isa_ipmi_bt_get_backend_data(IPMIInterface * ii)130 static void *isa_ipmi_bt_get_backend_data(IPMIInterface *ii)
131 {
132     ISAIPMIBTDevice *iib = ISA_IPMI_BT(ii);
133 
134     return &iib->bt;
135 }
136 
137 static const Property ipmi_isa_properties[] = {
138     DEFINE_PROP_UINT32("ioport", ISAIPMIBTDevice, bt.io_base,  0xe4),
139     DEFINE_PROP_INT32("irq",   ISAIPMIBTDevice, isairq,  5),
140 };
141 
isa_ipmi_bt_class_init(ObjectClass * oc,const void * data)142 static void isa_ipmi_bt_class_init(ObjectClass *oc, const void *data)
143 {
144     DeviceClass *dc = DEVICE_CLASS(oc);
145     IPMIInterfaceClass *iic = IPMI_INTERFACE_CLASS(oc);
146     AcpiDevAmlIfClass *adevc = ACPI_DEV_AML_IF_CLASS(oc);
147 
148     dc->realize = isa_ipmi_bt_realize;
149     dc->vmsd = &vmstate_ISAIPMIBTDevice;
150     device_class_set_props(dc, ipmi_isa_properties);
151 
152     iic->get_backend_data = isa_ipmi_bt_get_backend_data;
153     ipmi_bt_class_init(iic);
154     iic->get_fwinfo = isa_ipmi_bt_get_fwinfo;
155     adevc->build_dev_aml = build_ipmi_dev_aml;
156 }
157 
158 static const TypeInfo isa_ipmi_bt_info = {
159     .name          = TYPE_ISA_IPMI_BT,
160     .parent        = TYPE_ISA_DEVICE,
161     .instance_size = sizeof(ISAIPMIBTDevice),
162     .instance_init = isa_ipmi_bt_init,
163     .class_init    = isa_ipmi_bt_class_init,
164     .interfaces = (const InterfaceInfo[]) {
165         { TYPE_IPMI_INTERFACE },
166         { TYPE_ACPI_DEV_AML_IF },
167         { }
168     }
169 };
170 
ipmi_register_types(void)171 static void ipmi_register_types(void)
172 {
173     type_register_static(&isa_ipmi_bt_info);
174 }
175 
176 type_init(ipmi_register_types)
177