2 * QEMU ISA IPMI KCS 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
25 #include "qemu/osdep.h"
27 #include "qemu/module.h"
28 #include "qapi/error.h"
30 #include "hw/ipmi/ipmi.h"
32 #include "hw/isa/isa.h"
34 #define IPMI_KCS_OBF_BIT 0
35 #define IPMI_KCS_IBF_BIT 1
36 #define IPMI_KCS_SMS_ATN_BIT 2
37 #define IPMI_KCS_CD_BIT 3
39 #define IPMI_KCS_OBF_MASK (1 << IPMI_KCS_OBF_BIT)
40 #define IPMI_KCS_GET_OBF(d) (((d) >> IPMI_KCS_OBF_BIT) & 0x1)
41 #define IPMI_KCS_SET_OBF(d, v) (d) = (((d) & ~IPMI_KCS_OBF_MASK) | \
42 (((v) & 1) << IPMI_KCS_OBF_BIT))
43 #define IPMI_KCS_IBF_MASK (1 << IPMI_KCS_IBF_BIT)
44 #define IPMI_KCS_GET_IBF(d) (((d) >> IPMI_KCS_IBF_BIT) & 0x1)
45 #define IPMI_KCS_SET_IBF(d, v) (d) = (((d) & ~IPMI_KCS_IBF_MASK) | \
46 (((v) & 1) << IPMI_KCS_IBF_BIT))
47 #define IPMI_KCS_SMS_ATN_MASK (1 << IPMI_KCS_SMS_ATN_BIT)
48 #define IPMI_KCS_GET_SMS_ATN(d) (((d) >> IPMI_KCS_SMS_ATN_BIT) & 0x1)
49 #define IPMI_KCS_SET_SMS_ATN(d, v) (d) = (((d) & ~IPMI_KCS_SMS_ATN_MASK) | \
50 (((v) & 1) << IPMI_KCS_SMS_ATN_BIT))
51 #define IPMI_KCS_CD_MASK (1 << IPMI_KCS_CD_BIT)
52 #define IPMI_KCS_GET_CD(d) (((d) >> IPMI_KCS_CD_BIT) & 0x1)
53 #define IPMI_KCS_SET_CD(d, v) (d) = (((d) & ~IPMI_KCS_CD_MASK) | \
54 (((v) & 1) << IPMI_KCS_CD_BIT))
56 #define IPMI_KCS_IDLE_STATE 0
57 #define IPMI_KCS_READ_STATE 1
58 #define IPMI_KCS_WRITE_STATE 2
59 #define IPMI_KCS_ERROR_STATE 3
61 #define IPMI_KCS_GET_STATE(d) (((d) >> 6) & 0x3)
62 #define IPMI_KCS_SET_STATE(d, v) ((d) = ((d) & ~0xc0) | (((v) & 0x3) << 6))
64 #define IPMI_KCS_ABORT_STATUS_CMD 0x60
65 #define IPMI_KCS_WRITE_START_CMD 0x61
66 #define IPMI_KCS_WRITE_END_CMD 0x62
67 #define IPMI_KCS_READ_CMD 0x68
69 #define IPMI_KCS_STATUS_NO_ERR 0x00
70 #define IPMI_KCS_STATUS_ABORTED_ERR 0x01
71 #define IPMI_KCS_STATUS_BAD_CC_ERR 0x02
72 #define IPMI_KCS_STATUS_LENGTH_ERR 0x06
74 typedef struct IPMIKCS
{
82 unsigned long io_length
;
90 uint8_t outmsg
[MAX_IPMI_MSG_SIZE
];
94 uint8_t inmsg
[MAX_IPMI_MSG_SIZE
];
101 int16_t data_in_reg
; /* -1 means not written */
105 * This is a response number that we send with the command to make
106 * sure that the response matches the command.
113 IPMI_KCS_SET_OBF(ik->status_reg, 1); \
114 if (ik->use_irq && ik->irqs_enabled && !ik->obf_irq_set) { \
115 ik->obf_irq_set = 1; \
116 if (!ik->atn_irq_set) { \
117 qemu_irq_raise(ik->irq); \
122 static void ipmi_kcs_signal(IPMIKCS
*ik
, IPMIInterface
*ii
)
124 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
127 while (ik
->do_wake
) {
129 iic
->handle_if_event(ii
);
133 static void ipmi_kcs_handle_event(IPMIInterface
*ii
)
135 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
136 IPMIKCS
*ik
= iic
->get_backend_data(ii
);
138 if (ik
->cmd_reg
== IPMI_KCS_ABORT_STATUS_CMD
) {
139 if (IPMI_KCS_GET_STATE(ik
->status_reg
) != IPMI_KCS_ERROR_STATE
) {
140 ik
->waiting_rsp
++; /* Invalidate the message */
141 ik
->outmsg
[0] = IPMI_KCS_STATUS_ABORTED_ERR
;
144 IPMI_KCS_SET_STATE(ik
->status_reg
, IPMI_KCS_ERROR_STATE
);
150 switch (IPMI_KCS_GET_STATE(ik
->status_reg
)) {
151 case IPMI_KCS_IDLE_STATE
:
152 if (ik
->cmd_reg
== IPMI_KCS_WRITE_START_CMD
) {
153 IPMI_KCS_SET_STATE(ik
->status_reg
, IPMI_KCS_WRITE_STATE
);
161 case IPMI_KCS_READ_STATE
:
163 if (ik
->outpos
>= ik
->outlen
) {
164 IPMI_KCS_SET_STATE(ik
->status_reg
, IPMI_KCS_IDLE_STATE
);
166 } else if (ik
->data_in_reg
== IPMI_KCS_READ_CMD
) {
167 ik
->data_out_reg
= ik
->outmsg
[ik
->outpos
];
171 ik
->outmsg
[0] = IPMI_KCS_STATUS_BAD_CC_ERR
;
174 IPMI_KCS_SET_STATE(ik
->status_reg
, IPMI_KCS_ERROR_STATE
);
180 case IPMI_KCS_WRITE_STATE
:
181 if (ik
->data_in_reg
!= -1) {
183 * Don't worry about input overrun here, that will be
184 * handled in the BMC.
186 if (ik
->inlen
< sizeof(ik
->inmsg
)) {
187 ik
->inmsg
[ik
->inlen
] = ik
->data_in_reg
;
192 IPMIBmcClass
*bk
= IPMI_BMC_GET_CLASS(ik
->bmc
);
196 bk
->handle_command(ik
->bmc
, ik
->inmsg
, ik
->inlen
, sizeof(ik
->inmsg
),
199 } else if (ik
->cmd_reg
== IPMI_KCS_WRITE_END_CMD
) {
206 case IPMI_KCS_ERROR_STATE
:
207 if (ik
->data_in_reg
!= -1) {
208 IPMI_KCS_SET_STATE(ik
->status_reg
, IPMI_KCS_READ_STATE
);
209 ik
->data_in_reg
= IPMI_KCS_READ_CMD
;
215 if (ik
->cmd_reg
!= -1) {
216 /* Got an invalid command */
217 ik
->outmsg
[0] = IPMI_KCS_STATUS_BAD_CC_ERR
;
220 IPMI_KCS_SET_STATE(ik
->status_reg
, IPMI_KCS_ERROR_STATE
);
225 ik
->data_in_reg
= -1;
226 IPMI_KCS_SET_IBF(ik
->status_reg
, 0);
231 static void ipmi_kcs_handle_rsp(IPMIInterface
*ii
, uint8_t msg_id
,
232 unsigned char *rsp
, unsigned int rsp_len
)
234 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
235 IPMIKCS
*ik
= iic
->get_backend_data(ii
);
237 if (ik
->waiting_rsp
== msg_id
) {
239 if (rsp_len
> sizeof(ik
->outmsg
)) {
240 ik
->outmsg
[0] = rsp
[0];
241 ik
->outmsg
[1] = rsp
[1];
242 ik
->outmsg
[2] = IPMI_CC_CANNOT_RETURN_REQ_NUM_BYTES
;
245 memcpy(ik
->outmsg
, rsp
, rsp_len
);
246 ik
->outlen
= rsp_len
;
248 IPMI_KCS_SET_STATE(ik
->status_reg
, IPMI_KCS_READ_STATE
);
249 ik
->data_in_reg
= IPMI_KCS_READ_CMD
;
250 ipmi_kcs_signal(ik
, ii
);
255 static uint64_t ipmi_kcs_ioport_read(void *opaque
, hwaddr addr
, unsigned size
)
257 IPMIInterface
*ii
= opaque
;
258 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
259 IPMIKCS
*ik
= iic
->get_backend_data(ii
);
264 ret
= ik
->data_out_reg
;
265 IPMI_KCS_SET_OBF(ik
->status_reg
, 0);
266 if (ik
->obf_irq_set
) {
268 if (!ik
->atn_irq_set
) {
269 qemu_irq_lower(ik
->irq
);
274 ret
= ik
->status_reg
;
275 if (ik
->atn_irq_set
) {
277 if (!ik
->obf_irq_set
) {
278 qemu_irq_lower(ik
->irq
);
286 static void ipmi_kcs_ioport_write(void *opaque
, hwaddr addr
, uint64_t val
,
289 IPMIInterface
*ii
= opaque
;
290 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
291 IPMIKCS
*ik
= iic
->get_backend_data(ii
);
293 if (IPMI_KCS_GET_IBF(ik
->status_reg
)) {
299 ik
->data_in_reg
= val
;
306 IPMI_KCS_SET_IBF(ik
->status_reg
, 1);
307 ipmi_kcs_signal(ik
, ii
);
310 const MemoryRegionOps ipmi_kcs_io_ops
= {
311 .read
= ipmi_kcs_ioport_read
,
312 .write
= ipmi_kcs_ioport_write
,
314 .min_access_size
= 1,
315 .max_access_size
= 1,
317 .endianness
= DEVICE_LITTLE_ENDIAN
,
320 static void ipmi_kcs_set_atn(IPMIInterface
*ii
, int val
, int irq
)
322 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
323 IPMIKCS
*ik
= iic
->get_backend_data(ii
);
325 IPMI_KCS_SET_SMS_ATN(ik
->status_reg
, val
);
327 if (irq
&& !ik
->atn_irq_set
&& ik
->use_irq
&& ik
->irqs_enabled
) {
329 if (!ik
->obf_irq_set
) {
330 qemu_irq_raise(ik
->irq
);
334 if (ik
->atn_irq_set
) {
336 if (!ik
->obf_irq_set
) {
337 qemu_irq_lower(ik
->irq
);
343 static void ipmi_kcs_set_irq_enable(IPMIInterface
*ii
, int val
)
345 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
346 IPMIKCS
*ik
= iic
->get_backend_data(ii
);
348 ik
->irqs_enabled
= val
;
351 static void ipmi_kcs_init(IPMIInterface
*ii
, Error
**errp
)
353 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
354 IPMIKCS
*ik
= iic
->get_backend_data(ii
);
357 memory_region_init_io(&ik
->io
, NULL
, &ipmi_kcs_io_ops
, ii
, "ipmi-kcs", 2);
360 #define TYPE_ISA_IPMI_KCS "isa-ipmi-kcs"
361 #define ISA_IPMI_KCS(obj) OBJECT_CHECK(ISAIPMIKCSDevice, (obj), \
364 typedef struct ISAIPMIKCSDevice
{
371 static void ipmi_kcs_get_fwinfo(IPMIInterface
*ii
, IPMIFwInfo
*info
)
373 ISAIPMIKCSDevice
*iik
= ISA_IPMI_KCS(ii
);
375 info
->interface_name
= "kcs";
376 info
->interface_type
= IPMI_SMBIOS_KCS
;
377 info
->ipmi_spec_major_revision
= 2;
378 info
->ipmi_spec_minor_revision
= 0;
379 info
->base_address
= iik
->kcs
.io_base
;
380 info
->i2c_slave_address
= iik
->kcs
.bmc
->slave_addr
;
381 info
->register_length
= iik
->kcs
.io_length
;
382 info
->register_spacing
= 1;
383 info
->memspace
= IPMI_MEMSPACE_IO
;
384 info
->irq_type
= IPMI_LEVEL_IRQ
;
385 info
->interrupt_number
= iik
->isairq
;
386 info
->uuid
= iik
->uuid
;
389 static void ipmi_kcs_class_init(IPMIInterfaceClass
*iic
)
391 iic
->init
= ipmi_kcs_init
;
392 iic
->set_atn
= ipmi_kcs_set_atn
;
393 iic
->handle_rsp
= ipmi_kcs_handle_rsp
;
394 iic
->handle_if_event
= ipmi_kcs_handle_event
;
395 iic
->set_irq_enable
= ipmi_kcs_set_irq_enable
;
396 iic
->get_fwinfo
= ipmi_kcs_get_fwinfo
;
399 static void ipmi_isa_realize(DeviceState
*dev
, Error
**errp
)
401 ISADevice
*isadev
= ISA_DEVICE(dev
);
402 ISAIPMIKCSDevice
*iik
= ISA_IPMI_KCS(dev
);
403 IPMIInterface
*ii
= IPMI_INTERFACE(dev
);
404 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_GET_CLASS(ii
);
407 error_setg(errp
, "IPMI device requires a bmc attribute to be set");
411 iik
->uuid
= ipmi_next_uuid();
413 iik
->kcs
.bmc
->intf
= ii
;
419 if (iik
->isairq
> 0) {
420 isa_init_irq(isadev
, &iik
->kcs
.irq
, iik
->isairq
);
421 iik
->kcs
.use_irq
= 1;
424 qdev_set_legacy_instance_id(dev
, iik
->kcs
.io_base
, iik
->kcs
.io_length
);
426 isa_register_ioport(isadev
, &iik
->kcs
.io
, iik
->kcs
.io_base
);
429 static int ipmi_kcs_vmstate_post_load(void *opaque
, int version
)
431 IPMIKCS
*ik
= opaque
;
433 /* Make sure all the values are sane. */
434 if (ik
->outpos
>= MAX_IPMI_MSG_SIZE
|| ik
->outlen
>= MAX_IPMI_MSG_SIZE
||
435 ik
->outpos
>= ik
->outlen
) {
436 qemu_log_mask(LOG_GUEST_ERROR
,
437 "ipmi:kcs: vmstate transfer received bad out values: %d %d\n",
438 ik
->outpos
, ik
->outlen
);
443 if (ik
->inlen
>= MAX_IPMI_MSG_SIZE
) {
444 qemu_log_mask(LOG_GUEST_ERROR
,
445 "ipmi:kcs: vmstate transfer received bad in value: %d\n",
453 static bool vmstate_kcs_before_version2(void *opaque
, int version
)
458 static const VMStateDescription vmstate_IPMIKCS
= {
459 .name
= TYPE_IPMI_INTERFACE_PREFIX
"kcs",
461 .minimum_version_id
= 1,
462 .post_load
= ipmi_kcs_vmstate_post_load
,
463 .fields
= (VMStateField
[]) {
464 VMSTATE_BOOL(obf_irq_set
, IPMIKCS
),
465 VMSTATE_BOOL(atn_irq_set
, IPMIKCS
),
466 VMSTATE_UNUSED_TEST(vmstate_kcs_before_version2
, 1), /* Was use_irq */
467 VMSTATE_BOOL(irqs_enabled
, IPMIKCS
),
468 VMSTATE_UINT32(outpos
, IPMIKCS
),
469 VMSTATE_UINT32_V(outlen
, IPMIKCS
, 2),
470 VMSTATE_UINT8_ARRAY(outmsg
, IPMIKCS
, MAX_IPMI_MSG_SIZE
),
471 VMSTATE_UINT32_V(inlen
, IPMIKCS
, 2),
472 VMSTATE_UINT8_ARRAY(inmsg
, IPMIKCS
, MAX_IPMI_MSG_SIZE
),
473 VMSTATE_BOOL(write_end
, IPMIKCS
),
474 VMSTATE_UINT8(status_reg
, IPMIKCS
),
475 VMSTATE_UINT8(data_out_reg
, IPMIKCS
),
476 VMSTATE_INT16(data_in_reg
, IPMIKCS
),
477 VMSTATE_INT16(cmd_reg
, IPMIKCS
),
478 VMSTATE_UINT8(waiting_rsp
, IPMIKCS
),
479 VMSTATE_END_OF_LIST()
483 static const VMStateDescription vmstate_ISAIPMIKCSDevice
= {
484 .name
= TYPE_IPMI_INTERFACE
,
486 .minimum_version_id
= 1,
487 .fields
= (VMStateField
[]) {
488 VMSTATE_VSTRUCT_TEST(kcs
, ISAIPMIKCSDevice
, vmstate_kcs_before_version2
,
489 0, vmstate_IPMIKCS
, IPMIKCS
, 1),
490 VMSTATE_VSTRUCT_V(kcs
, ISAIPMIKCSDevice
, 2, vmstate_IPMIKCS
,
492 VMSTATE_END_OF_LIST()
496 static void isa_ipmi_kcs_init(Object
*obj
)
498 ISAIPMIKCSDevice
*iik
= ISA_IPMI_KCS(obj
);
500 ipmi_bmc_find_and_link(obj
, (Object
**) &iik
->kcs
.bmc
);
503 * Version 1 had an incorrect name, it clashed with the BT
504 * IPMI device, so receive it, but transmit a different
507 vmstate_register(NULL
, 0, &vmstate_ISAIPMIKCSDevice
, iik
);
510 static void *isa_ipmi_kcs_get_backend_data(IPMIInterface
*ii
)
512 ISAIPMIKCSDevice
*iik
= ISA_IPMI_KCS(ii
);
517 static Property ipmi_isa_properties
[] = {
518 DEFINE_PROP_UINT32("ioport", ISAIPMIKCSDevice
, kcs
.io_base
, 0xca2),
519 DEFINE_PROP_INT32("irq", ISAIPMIKCSDevice
, isairq
, 5),
520 DEFINE_PROP_END_OF_LIST(),
523 static void isa_ipmi_kcs_class_init(ObjectClass
*oc
, void *data
)
525 DeviceClass
*dc
= DEVICE_CLASS(oc
);
526 IPMIInterfaceClass
*iic
= IPMI_INTERFACE_CLASS(oc
);
528 dc
->realize
= ipmi_isa_realize
;
529 dc
->props
= ipmi_isa_properties
;
531 iic
->get_backend_data
= isa_ipmi_kcs_get_backend_data
;
532 ipmi_kcs_class_init(iic
);
535 static const TypeInfo isa_ipmi_kcs_info
= {
536 .name
= TYPE_ISA_IPMI_KCS
,
537 .parent
= TYPE_ISA_DEVICE
,
538 .instance_size
= sizeof(ISAIPMIKCSDevice
),
539 .instance_init
= isa_ipmi_kcs_init
,
540 .class_init
= isa_ipmi_kcs_class_init
,
541 .interfaces
= (InterfaceInfo
[]) {
542 { TYPE_IPMI_INTERFACE
},
547 static void ipmi_register_types(void)
549 type_register_static(&isa_ipmi_kcs_info
);
552 type_init(ipmi_register_types
)