2 * QEMU ISA IPMI BT emulation
4 * Copyright (c) 2015 Corey Minyard, MontaVista Software, LLC
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
24 #include "qemu/osdep.h"
25 #include "qapi/error.h"
27 #include "hw/ipmi/ipmi.h"
28 #include "hw/isa/isa.h"
29 #include "hw/i386/pc.h"
31 /* Control register */
32 #define IPMI_BT_CLR_WR_BIT 0
33 #define IPMI_BT_CLR_RD_BIT 1
34 #define IPMI_BT_H2B_ATN_BIT 2
35 #define IPMI_BT_B2H_ATN_BIT 3
36 #define IPMI_BT_SMS_ATN_BIT 4
37 #define IPMI_BT_HBUSY_BIT 6
38 #define IPMI_BT_BBUSY_BIT 7
40 #define IPMI_BT_CLR_WR_MASK (1 << IPMI_BT_CLR_WR_BIT)
41 #define IPMI_BT_GET_CLR_WR(d) (((d) >> IPMI_BT_CLR_WR_BIT) & 0x1)
42 #define IPMI_BT_SET_CLR_WR(d, v) (d) = (((d) & ~IPMI_BT_CLR_WR_MASK) | \
43 (((v & 1) << IPMI_BT_CLR_WR_BIT)))
45 #define IPMI_BT_CLR_RD_MASK (1 << IPMI_BT_CLR_RD_BIT)
46 #define IPMI_BT_GET_CLR_RD(d) (((d) >> IPMI_BT_CLR_RD_BIT) & 0x1)
47 #define IPMI_BT_SET_CLR_RD(d, v) (d) = (((d) & ~IPMI_BT_CLR_RD_MASK) | \
48 (((v & 1) << IPMI_BT_CLR_RD_BIT)))
50 #define IPMI_BT_H2B_ATN_MASK (1 << IPMI_BT_H2B_ATN_BIT)
51 #define IPMI_BT_GET_H2B_ATN(d) (((d) >> IPMI_BT_H2B_ATN_BIT) & 0x1)
52 #define IPMI_BT_SET_H2B_ATN(d, v) (d) = (((d) & ~IPMI_BT_H2B_ATN_MASK) | \
53 (((v & 1) << IPMI_BT_H2B_ATN_BIT)))
55 #define IPMI_BT_B2H_ATN_MASK (1 << IPMI_BT_B2H_ATN_BIT)
56 #define IPMI_BT_GET_B2H_ATN(d) (((d) >> IPMI_BT_B2H_ATN_BIT) & 0x1)
57 #define IPMI_BT_SET_B2H_ATN(d, v) (d) = (((d) & ~IPMI_BT_B2H_ATN_MASK) | \
58 (((v & 1) << IPMI_BT_B2H_ATN_BIT)))
60 #define IPMI_BT_SMS_ATN_MASK (1 << IPMI_BT_SMS_ATN_BIT)
61 #define IPMI_BT_GET_SMS_ATN(d) (((d) >> IPMI_BT_SMS_ATN_BIT) & 0x1)
62 #define IPMI_BT_SET_SMS_ATN(d, v) (d) = (((d) & ~IPMI_BT_SMS_ATN_MASK) | \
63 (((v & 1) << IPMI_BT_SMS_ATN_BIT)))
65 #define IPMI_BT_HBUSY_MASK (1 << IPMI_BT_HBUSY_BIT)
66 #define IPMI_BT_GET_HBUSY(d) (((d) >> IPMI_BT_HBUSY_BIT) & 0x1)
67 #define IPMI_BT_SET_HBUSY(d, v) (d) = (((d) & ~IPMI_BT_HBUSY_MASK) | \
68 (((v & 1) << IPMI_BT_HBUSY_BIT)))
70 #define IPMI_BT_BBUSY_MASK (1 << IPMI_BT_BBUSY_BIT)
71 #define IPMI_BT_GET_BBUSY(d) (((d) >> IPMI_BT_BBUSY_BIT) & 0x1)
72 #define IPMI_BT_SET_BBUSY(d, v) (d) = (((d) & ~IPMI_BT_BBUSY_MASK) | \
73 (((v & 1) << IPMI_BT_BBUSY_BIT)))
77 #define IPMI_BT_B2H_IRQ_EN_BIT 0
78 #define IPMI_BT_B2H_IRQ_BIT 1
80 #define IPMI_BT_B2H_IRQ_EN_MASK (1 << IPMI_BT_B2H_IRQ_EN_BIT)
81 #define IPMI_BT_GET_B2H_IRQ_EN(d) (((d) >> IPMI_BT_B2H_IRQ_EN_BIT) & 0x1)
82 #define IPMI_BT_SET_B2H_IRQ_EN(d, v) (d) = (((d) & ~IPMI_BT_B2H_IRQ_EN_MASK) | \
83 (((v & 1) << IPMI_BT_B2H_IRQ_EN_BIT)))
85 #define IPMI_BT_B2H_IRQ_MASK (1 << IPMI_BT_B2H_IRQ_BIT)
86 #define IPMI_BT_GET_B2H_IRQ(d) (((d) >> IPMI_BT_B2H_IRQ_BIT) & 0x1)
87 #define IPMI_BT_SET_B2H_IRQ(d, v) (d) = (((d) & ~IPMI_BT_B2H_IRQ_MASK) | \
88 (((v & 1) << IPMI_BT_B2H_IRQ_BIT)))
90 typedef struct IPMIBT
{
98 unsigned long io_length
;
106 uint8_t outmsg
[MAX_IPMI_MSG_SIZE
];
110 uint8_t inmsg
[MAX_IPMI_MSG_SIZE
];
117 * This is a response number that we send with the command to make
118 * sure that the response matches the command.
124 #define IPMI_CMD_GET_BT_INTF_CAP 0x36
126 static void ipmi_bt_handle_event(IPMIInterface
*ii
)
128 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
129 IPMIBT
*ib
= iic
->get_backend_data(ii
);
134 /* Note that overruns are handled by handle_command */
135 if (ib
->inmsg
[0] != (ib
->inlen
- 1)) {
136 /* Length mismatch, just ignore. */
137 IPMI_BT_SET_BBUSY(ib
->control_reg
, 1);
141 if ((ib
->inmsg
[1] == (IPMI_NETFN_APP
<< 2)) &&
142 (ib
->inmsg
[3] == IPMI_CMD_GET_BT_INTF_CAP
)) {
143 /* We handle this one ourselves. */
145 ib
->outmsg
[1] = ib
->inmsg
[1] | 0x04;
146 ib
->outmsg
[2] = ib
->inmsg
[2];
147 ib
->outmsg
[3] = ib
->inmsg
[3];
149 ib
->outmsg
[5] = 1; /* Only support 1 outstanding request. */
150 if (sizeof(ib
->inmsg
) > 0xff) { /* Input buffer size */
151 ib
->outmsg
[6] = 0xff;
153 ib
->outmsg
[6] = (unsigned char) sizeof(ib
->inmsg
);
155 if (sizeof(ib
->outmsg
) > 0xff) { /* Output buffer size */
156 ib
->outmsg
[7] = 0xff;
158 ib
->outmsg
[7] = (unsigned char) sizeof(ib
->outmsg
);
160 ib
->outmsg
[8] = 10; /* Max request to response time */
161 ib
->outmsg
[9] = 0; /* Don't recommend retries */
163 IPMI_BT_SET_BBUSY(ib
->control_reg
, 0);
164 IPMI_BT_SET_B2H_ATN(ib
->control_reg
, 1);
165 if (ib
->use_irq
&& ib
->irqs_enabled
&&
166 !IPMI_BT_GET_B2H_IRQ(ib
->mask_reg
) &&
167 IPMI_BT_GET_B2H_IRQ_EN(ib
->mask_reg
)) {
168 IPMI_BT_SET_B2H_IRQ(ib
->mask_reg
, 1);
169 qemu_irq_raise(ib
->irq
);
173 ib
->waiting_seq
= ib
->inmsg
[2];
174 ib
->inmsg
[2] = ib
->inmsg
[1];
176 IPMIBmcClass
*bk
= IPMI_BMC_GET_CLASS(ib
->bmc
);
177 bk
->handle_command(ib
->bmc
, ib
->inmsg
+ 2, ib
->inlen
- 2,
178 sizeof(ib
->inmsg
), ib
->waiting_rsp
);
184 static void ipmi_bt_handle_rsp(IPMIInterface
*ii
, uint8_t msg_id
,
185 unsigned char *rsp
, unsigned int rsp_len
)
187 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
188 IPMIBT
*ib
= iic
->get_backend_data(ii
);
190 if (ib
->waiting_rsp
== msg_id
) {
192 if (rsp_len
> (sizeof(ib
->outmsg
) - 2)) {
194 ib
->outmsg
[1] = rsp
[0];
195 ib
->outmsg
[2] = ib
->waiting_seq
;
196 ib
->outmsg
[3] = rsp
[1];
197 ib
->outmsg
[4] = IPMI_CC_CANNOT_RETURN_REQ_NUM_BYTES
;
200 ib
->outmsg
[0] = rsp_len
+ 1;
201 ib
->outmsg
[1] = rsp
[0];
202 ib
->outmsg
[2] = ib
->waiting_seq
;
203 memcpy(ib
->outmsg
+ 3, rsp
+ 1, rsp_len
- 1);
204 ib
->outlen
= rsp_len
+ 2;
206 IPMI_BT_SET_BBUSY(ib
->control_reg
, 0);
207 IPMI_BT_SET_B2H_ATN(ib
->control_reg
, 1);
208 if (ib
->use_irq
&& ib
->irqs_enabled
&&
209 !IPMI_BT_GET_B2H_IRQ(ib
->mask_reg
) &&
210 IPMI_BT_GET_B2H_IRQ_EN(ib
->mask_reg
)) {
211 IPMI_BT_SET_B2H_IRQ(ib
->mask_reg
, 1);
212 qemu_irq_raise(ib
->irq
);
218 static uint64_t ipmi_bt_ioport_read(void *opaque
, hwaddr addr
, unsigned size
)
220 IPMIInterface
*ii
= opaque
;
221 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
222 IPMIBT
*ib
= iic
->get_backend_data(ii
);
227 ret
= ib
->control_reg
;
230 if (ib
->outpos
< ib
->outlen
) {
231 ret
= ib
->outmsg
[ib
->outpos
];
233 if (ib
->outpos
== ib
->outlen
) {
248 static void ipmi_bt_signal(IPMIBT
*ib
, IPMIInterface
*ii
)
250 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
253 while (ib
->do_wake
) {
255 iic
->handle_if_event(ii
);
259 static void ipmi_bt_ioport_write(void *opaque
, hwaddr addr
, uint64_t val
,
262 IPMIInterface
*ii
= opaque
;
263 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
264 IPMIBT
*ib
= iic
->get_backend_data(ii
);
268 if (IPMI_BT_GET_CLR_WR(val
)) {
271 if (IPMI_BT_GET_CLR_RD(val
)) {
274 if (IPMI_BT_GET_B2H_ATN(val
)) {
275 IPMI_BT_SET_B2H_ATN(ib
->control_reg
, 0);
277 if (IPMI_BT_GET_SMS_ATN(val
)) {
278 IPMI_BT_SET_SMS_ATN(ib
->control_reg
, 0);
280 if (IPMI_BT_GET_HBUSY(val
)) {
282 IPMI_BT_SET_HBUSY(ib
->control_reg
,
283 !IPMI_BT_GET_HBUSY(ib
->control_reg
));
285 if (IPMI_BT_GET_H2B_ATN(val
)) {
286 IPMI_BT_SET_BBUSY(ib
->control_reg
, 1);
287 ipmi_bt_signal(ib
, ii
);
292 if (ib
->inlen
< sizeof(ib
->inmsg
)) {
293 ib
->inmsg
[ib
->inlen
] = val
;
299 if (IPMI_BT_GET_B2H_IRQ_EN(val
) !=
300 IPMI_BT_GET_B2H_IRQ_EN(ib
->mask_reg
)) {
301 if (IPMI_BT_GET_B2H_IRQ_EN(val
)) {
302 if (IPMI_BT_GET_B2H_ATN(ib
->control_reg
) ||
303 IPMI_BT_GET_SMS_ATN(ib
->control_reg
)) {
304 IPMI_BT_SET_B2H_IRQ(ib
->mask_reg
, 1);
305 qemu_irq_raise(ib
->irq
);
307 IPMI_BT_SET_B2H_IRQ_EN(ib
->mask_reg
, 1);
309 if (IPMI_BT_GET_B2H_IRQ(ib
->mask_reg
)) {
310 IPMI_BT_SET_B2H_IRQ(ib
->mask_reg
, 0);
311 qemu_irq_lower(ib
->irq
);
313 IPMI_BT_SET_B2H_IRQ_EN(ib
->mask_reg
, 0);
316 if (IPMI_BT_GET_B2H_IRQ(val
) && IPMI_BT_GET_B2H_IRQ(ib
->mask_reg
)) {
317 IPMI_BT_SET_B2H_IRQ(ib
->mask_reg
, 0);
318 qemu_irq_lower(ib
->irq
);
324 static const MemoryRegionOps ipmi_bt_io_ops
= {
325 .read
= ipmi_bt_ioport_read
,
326 .write
= ipmi_bt_ioport_write
,
328 .min_access_size
= 1,
329 .max_access_size
= 1,
331 .endianness
= DEVICE_LITTLE_ENDIAN
,
334 static void ipmi_bt_set_atn(IPMIInterface
*ii
, int val
, int irq
)
336 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
337 IPMIBT
*ib
= iic
->get_backend_data(ii
);
339 if (!!val
== IPMI_BT_GET_SMS_ATN(ib
->control_reg
)) {
343 IPMI_BT_SET_SMS_ATN(ib
->control_reg
, val
);
345 if (irq
&& ib
->use_irq
&& ib
->irqs_enabled
&&
346 !IPMI_BT_GET_B2H_ATN(ib
->control_reg
) &&
347 IPMI_BT_GET_B2H_IRQ_EN(ib
->mask_reg
)) {
348 IPMI_BT_SET_B2H_IRQ(ib
->mask_reg
, 1);
349 qemu_irq_raise(ib
->irq
);
352 if (!IPMI_BT_GET_B2H_ATN(ib
->control_reg
) &&
353 IPMI_BT_GET_B2H_IRQ(ib
->mask_reg
)) {
354 IPMI_BT_SET_B2H_IRQ(ib
->mask_reg
, 0);
355 qemu_irq_lower(ib
->irq
);
360 static void ipmi_bt_handle_reset(IPMIInterface
*ii
, bool is_cold
)
362 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
363 IPMIBT
*ib
= iic
->get_backend_data(ii
);
366 /* Disable the BT interrupt on reset */
367 if (IPMI_BT_GET_B2H_IRQ(ib
->mask_reg
)) {
368 IPMI_BT_SET_B2H_IRQ(ib
->mask_reg
, 0);
369 qemu_irq_lower(ib
->irq
);
371 IPMI_BT_SET_B2H_IRQ_EN(ib
->mask_reg
, 0);
375 static void ipmi_bt_set_irq_enable(IPMIInterface
*ii
, int val
)
377 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
378 IPMIBT
*ib
= iic
->get_backend_data(ii
);
380 ib
->irqs_enabled
= val
;
383 static void ipmi_bt_init(IPMIInterface
*ii
, Error
**errp
)
385 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
386 IPMIBT
*ib
= iic
->get_backend_data(ii
);
390 memory_region_init_io(&ib
->io
, NULL
, &ipmi_bt_io_ops
, ii
, "ipmi-bt", 3);
394 #define TYPE_ISA_IPMI_BT "isa-ipmi-bt"
395 #define ISA_IPMI_BT(obj) OBJECT_CHECK(ISAIPMIBTDevice, (obj), \
398 typedef struct ISAIPMIBTDevice
{
405 static void ipmi_bt_get_fwinfo(struct IPMIInterface
*ii
, IPMIFwInfo
*info
)
407 ISAIPMIBTDevice
*iib
= ISA_IPMI_BT(ii
);
409 info
->interface_name
= "bt";
410 info
->interface_type
= IPMI_SMBIOS_BT
;
411 info
->ipmi_spec_major_revision
= 2;
412 info
->ipmi_spec_minor_revision
= 0;
413 info
->base_address
= iib
->bt
.io_base
;
414 info
->register_length
= iib
->bt
.io_length
;
415 info
->register_spacing
= 1;
416 info
->memspace
= IPMI_MEMSPACE_IO
;
417 info
->irq_type
= IPMI_LEVEL_IRQ
;
418 info
->interrupt_number
= iib
->isairq
;
419 info
->i2c_slave_address
= iib
->bt
.bmc
->slave_addr
;
420 info
->uuid
= iib
->uuid
;
423 static void ipmi_bt_class_init(IPMIInterfaceClass
*iic
)
425 iic
->init
= ipmi_bt_init
;
426 iic
->set_atn
= ipmi_bt_set_atn
;
427 iic
->handle_rsp
= ipmi_bt_handle_rsp
;
428 iic
->handle_if_event
= ipmi_bt_handle_event
;
429 iic
->set_irq_enable
= ipmi_bt_set_irq_enable
;
430 iic
->reset
= ipmi_bt_handle_reset
;
431 iic
->get_fwinfo
= ipmi_bt_get_fwinfo
;
434 static void isa_ipmi_bt_realize(DeviceState
*dev
, Error
**errp
)
436 ISADevice
*isadev
= ISA_DEVICE(dev
);
437 ISAIPMIBTDevice
*iib
= ISA_IPMI_BT(dev
);
438 IPMIInterface
*ii
= IPMI_INTERFACE(dev
);
439 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
442 error_setg(errp
, "IPMI device requires a bmc attribute to be set");
446 iib
->uuid
= ipmi_next_uuid();
448 iib
->bt
.bmc
->intf
= ii
;
454 if (iib
->isairq
> 0) {
455 isa_init_irq(isadev
, &iib
->bt
.irq
, iib
->isairq
);
459 qdev_set_legacy_instance_id(dev
, iib
->bt
.io_base
, iib
->bt
.io_length
);
461 isa_register_ioport(isadev
, &iib
->bt
.io
, iib
->bt
.io_base
);
464 static const VMStateDescription vmstate_ISAIPMIBTDevice
= {
465 .name
= TYPE_IPMI_INTERFACE
,
467 .minimum_version_id
= 1,
468 .fields
= (VMStateField
[]) {
469 VMSTATE_BOOL(bt
.obf_irq_set
, ISAIPMIBTDevice
),
470 VMSTATE_BOOL(bt
.atn_irq_set
, ISAIPMIBTDevice
),
471 VMSTATE_BOOL(bt
.use_irq
, ISAIPMIBTDevice
),
472 VMSTATE_BOOL(bt
.irqs_enabled
, ISAIPMIBTDevice
),
473 VMSTATE_UINT32(bt
.outpos
, ISAIPMIBTDevice
),
474 VMSTATE_VBUFFER_UINT32(bt
.outmsg
, ISAIPMIBTDevice
, 1, NULL
, 0,
476 VMSTATE_VBUFFER_UINT32(bt
.inmsg
, ISAIPMIBTDevice
, 1, NULL
, 0,
478 VMSTATE_UINT8(bt
.control_reg
, ISAIPMIBTDevice
),
479 VMSTATE_UINT8(bt
.mask_reg
, ISAIPMIBTDevice
),
480 VMSTATE_UINT8(bt
.waiting_rsp
, ISAIPMIBTDevice
),
481 VMSTATE_UINT8(bt
.waiting_seq
, ISAIPMIBTDevice
),
482 VMSTATE_END_OF_LIST()
486 static void isa_ipmi_bt_init(Object
*obj
)
488 ISAIPMIBTDevice
*iib
= ISA_IPMI_BT(obj
);
490 ipmi_bmc_find_and_link(obj
, (Object
**) &iib
->bt
.bmc
);
492 vmstate_register(NULL
, 0, &vmstate_ISAIPMIBTDevice
, iib
);
495 static void *isa_ipmi_bt_get_backend_data(IPMIInterface
*ii
)
497 ISAIPMIBTDevice
*iib
= ISA_IPMI_BT(ii
);
502 static Property ipmi_isa_properties
[] = {
503 DEFINE_PROP_UINT32("ioport", ISAIPMIBTDevice
, bt
.io_base
, 0xe4),
504 DEFINE_PROP_INT32("irq", ISAIPMIBTDevice
, isairq
, 5),
505 DEFINE_PROP_END_OF_LIST(),
508 static void isa_ipmi_bt_class_init(ObjectClass
*oc
, void *data
)
510 DeviceClass
*dc
= DEVICE_CLASS(oc
);
511 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_CLASS(oc
);
513 dc
->realize
= isa_ipmi_bt_realize
;
514 dc
->props
= ipmi_isa_properties
;
516 iic
->get_backend_data
= isa_ipmi_bt_get_backend_data
;
517 ipmi_bt_class_init(iic
);
520 static const TypeInfo isa_ipmi_bt_info
= {
521 .name
= TYPE_ISA_IPMI_BT
,
522 .parent
= TYPE_ISA_DEVICE
,
523 .instance_size
= sizeof(ISAIPMIBTDevice
),
524 .instance_init
= isa_ipmi_bt_init
,
525 .class_init
= isa_ipmi_bt_class_init
,
526 .interfaces
= (InterfaceInfo
[]) {
527 { TYPE_IPMI_INTERFACE
},
532 static void ipmi_register_types(void)
534 type_register_static(&isa_ipmi_bt_info
);
537 type_init(ipmi_register_types
)