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 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->interrupt_number = iik->isairq; 53 info->uuid = iik->uuid; 54 } 55 56 static void isa_ipmi_kcs_raise_irq(IPMIKCS *ik) 57 { 58 ISAIPMIKCSDevice *iik = ik->opaque; 59 60 qemu_irq_raise(iik->irq); 61 } 62 63 static void isa_ipmi_kcs_lower_irq(IPMIKCS *ik) 64 { 65 ISAIPMIKCSDevice *iik = ik->opaque; 66 67 qemu_irq_lower(iik->irq); 68 } 69 70 static void ipmi_isa_realize(DeviceState *dev, Error **errp) 71 { 72 Error *err = NULL; 73 ISADevice *isadev = ISA_DEVICE(dev); 74 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(dev); 75 IPMIInterface *ii = IPMI_INTERFACE(dev); 76 IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii); 77 78 if (!iik->kcs.bmc) { 79 error_setg(errp, "IPMI device requires a bmc attribute to be set"); 80 return; 81 } 82 83 iik->uuid = ipmi_next_uuid(); 84 85 iik->kcs.bmc->intf = ii; 86 iik->kcs.opaque = iik; 87 88 iic->init(ii, 0, &err); 89 if (err) { 90 error_propagate(errp, err); 91 return; 92 } 93 94 if (iik->isairq > 0) { 95 iik->irq = isa_get_irq(isadev, iik->isairq); 96 iik->kcs.use_irq = 1; 97 iik->kcs.raise_irq = isa_ipmi_kcs_raise_irq; 98 iik->kcs.lower_irq = isa_ipmi_kcs_lower_irq; 99 } 100 101 qdev_set_legacy_instance_id(dev, iik->kcs.io_base, iik->kcs.io_length); 102 103 isa_register_ioport(isadev, &iik->kcs.io, iik->kcs.io_base); 104 } 105 106 static bool vmstate_kcs_before_version2(void *opaque, int version) 107 { 108 return version <= 1; 109 } 110 111 static const VMStateDescription vmstate_ISAIPMIKCSDevice = { 112 .name = TYPE_IPMI_INTERFACE, 113 .version_id = 2, 114 .minimum_version_id = 1, 115 .fields = (VMStateField[]) { 116 VMSTATE_VSTRUCT_TEST(kcs, ISAIPMIKCSDevice, vmstate_kcs_before_version2, 117 0, vmstate_IPMIKCS, IPMIKCS, 1), 118 VMSTATE_VSTRUCT_V(kcs, ISAIPMIKCSDevice, 2, vmstate_IPMIKCS, 119 IPMIKCS, 2), 120 VMSTATE_END_OF_LIST() 121 } 122 }; 123 124 static void isa_ipmi_kcs_init(Object *obj) 125 { 126 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(obj); 127 128 ipmi_bmc_find_and_link(obj, (Object **) &iik->kcs.bmc); 129 130 /* 131 * Version 1 had an incorrect name, it clashed with the BT 132 * IPMI device, so receive it, but transmit a different 133 * version. 134 */ 135 vmstate_register(NULL, 0, &vmstate_ISAIPMIKCSDevice, iik); 136 } 137 138 static void *isa_ipmi_kcs_get_backend_data(IPMIInterface *ii) 139 { 140 ISAIPMIKCSDevice *iik = ISA_IPMI_KCS(ii); 141 142 return &iik->kcs; 143 } 144 145 static 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 151 static void isa_ipmi_kcs_class_init(ObjectClass *oc, void *data) 152 { 153 DeviceClass *dc = DEVICE_CLASS(oc); 154 IPMIInterfaceClass *iic = IPMI_INTERFACE_CLASS(oc); 155 AcpiDevAmlIfClass *adevc = ACPI_DEV_AML_IF_CLASS(oc); 156 157 dc->realize = ipmi_isa_realize; 158 device_class_set_props(dc, ipmi_isa_properties); 159 160 iic->get_backend_data = isa_ipmi_kcs_get_backend_data; 161 ipmi_kcs_class_init(iic); 162 iic->get_fwinfo = isa_ipmi_kcs_get_fwinfo; 163 adevc->build_dev_aml = build_ipmi_dev_aml; 164 } 165 166 static 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 }, 174 { TYPE_ACPI_DEV_AML_IF }, 175 { } 176 } 177 }; 178 179 static void ipmi_register_types(void) 180 { 181 type_register_static(&isa_ipmi_kcs_info); 182 } 183 184 type_init(ipmi_register_types) 185