Coverage Report

Created: 2026-10-31 08:12

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/qemu/hw/ipmi/ipmi_bt.c
Line
Count
Source
1
/*
2
 * QEMU 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
#include "qemu/osdep.h"
25
#include "migration/vmstate.h"
26
#include "qemu/log.h"
27
#include "qapi/error.h"
28
#include "hw/ipmi/ipmi_bt.h"
29
30
/* Control register */
31
0
#define IPMI_BT_CLR_WR_BIT         0
32
0
#define IPMI_BT_CLR_RD_BIT         1
33
0
#define IPMI_BT_H2B_ATN_BIT        2
34
0
#define IPMI_BT_B2H_ATN_BIT        3
35
0
#define IPMI_BT_SMS_ATN_BIT        4
36
0
#define IPMI_BT_HBUSY_BIT          6
37
0
#define IPMI_BT_BBUSY_BIT          7
38
39
0
#define IPMI_BT_GET_CLR_WR(d)      (((d) >> IPMI_BT_CLR_WR_BIT) & 0x1)
40
41
0
#define IPMI_BT_GET_CLR_RD(d)      (((d) >> IPMI_BT_CLR_RD_BIT) & 0x1)
42
43
0
#define IPMI_BT_GET_H2B_ATN(d)     (((d) >> IPMI_BT_H2B_ATN_BIT) & 0x1)
44
45
0
#define IPMI_BT_B2H_ATN_MASK       (1 << IPMI_BT_B2H_ATN_BIT)
46
0
#define IPMI_BT_GET_B2H_ATN(d)     (((d) >> IPMI_BT_B2H_ATN_BIT) & 0x1)
47
0
#define IPMI_BT_SET_B2H_ATN(d, v)  ((d) = (((d) & ~IPMI_BT_B2H_ATN_MASK) | \
48
0
                                        (!!(v) << IPMI_BT_B2H_ATN_BIT)))
49
50
0
#define IPMI_BT_SMS_ATN_MASK       (1 << IPMI_BT_SMS_ATN_BIT)
51
0
#define IPMI_BT_GET_SMS_ATN(d)     (((d) >> IPMI_BT_SMS_ATN_BIT) & 0x1)
52
0
#define IPMI_BT_SET_SMS_ATN(d, v)  ((d) = (((d) & ~IPMI_BT_SMS_ATN_MASK) | \
53
0
                                        (!!(v) << IPMI_BT_SMS_ATN_BIT)))
54
55
0
#define IPMI_BT_HBUSY_MASK         (1 << IPMI_BT_HBUSY_BIT)
56
0
#define IPMI_BT_GET_HBUSY(d)       (((d) >> IPMI_BT_HBUSY_BIT) & 0x1)
57
0
#define IPMI_BT_SET_HBUSY(d, v)    ((d) = (((d) & ~IPMI_BT_HBUSY_MASK) | \
58
0
                                       (!!(v) << IPMI_BT_HBUSY_BIT)))
59
60
0
#define IPMI_BT_BBUSY_MASK         (1 << IPMI_BT_BBUSY_BIT)
61
0
#define IPMI_BT_SET_BBUSY(d, v)    ((d) = (((d) & ~IPMI_BT_BBUSY_MASK) | \
62
0
                                       (!!(v) << IPMI_BT_BBUSY_BIT)))
63
64
65
/* Mask register */
66
0
#define IPMI_BT_B2H_IRQ_EN_BIT     0
67
0
#define IPMI_BT_B2H_IRQ_BIT        1
68
69
0
#define IPMI_BT_B2H_IRQ_EN_MASK      (1 << IPMI_BT_B2H_IRQ_EN_BIT)
70
0
#define IPMI_BT_GET_B2H_IRQ_EN(d)    (((d) >> IPMI_BT_B2H_IRQ_EN_BIT) & 0x1)
71
0
#define IPMI_BT_SET_B2H_IRQ_EN(d, v) ((d) = (((d) & ~IPMI_BT_B2H_IRQ_EN_MASK) |\
72
0
                                        (!!(v) << IPMI_BT_B2H_IRQ_EN_BIT)))
73
74
0
#define IPMI_BT_B2H_IRQ_MASK         (1 << IPMI_BT_B2H_IRQ_BIT)
75
0
#define IPMI_BT_GET_B2H_IRQ(d)       (((d) >> IPMI_BT_B2H_IRQ_BIT) & 0x1)
76
0
#define IPMI_BT_SET_B2H_IRQ(d, v)    ((d) = (((d) & ~IPMI_BT_B2H_IRQ_MASK) | \
77
0
                                        (!!(v) << IPMI_BT_B2H_IRQ_BIT)))
78
79
0
#define IPMI_CMD_GET_BT_INTF_CAP        0x36
80
81
static void ipmi_bt_raise_irq(IPMIBT *ib)
82
0
{
83
0
    if (ib->use_irq && ib->irqs_enabled && ib->raise_irq) {
84
0
        ib->raise_irq(ib);
85
0
    }
86
0
}
87
88
static void ipmi_bt_lower_irq(IPMIBT *ib)
89
0
{
90
0
    if (ib->lower_irq) {
91
0
        ib->lower_irq(ib);
92
0
    }
93
0
}
94
95
static void ipmi_bt_handle_event(IPMIInterface *ii)
96
0
{
97
0
    IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
98
0
    IPMIBT *ib = iic->get_backend_data(ii);
99
100
0
    if (ib->inlen < 4) {
101
0
        return;
102
0
    }
103
    /* Note that overruns are handled by handle_command */
104
0
    if (ib->inmsg[0] != (ib->inlen - 1)) {
105
        /* Length mismatch, just ignore. */
106
0
        IPMI_BT_SET_BBUSY(ib->control_reg, 1);
107
0
        ib->inlen = 0;
108
0
        return;
109
0
    }
110
0
    if ((ib->inmsg[1] == (IPMI_NETFN_APP << 2)) &&
111
0
                        (ib->inmsg[3] == IPMI_CMD_GET_BT_INTF_CAP)) {
112
        /* We handle this one ourselves. */
113
0
        ib->outmsg[0] = 9;
114
0
        ib->outmsg[1] = ib->inmsg[1] | 0x04;
115
0
        ib->outmsg[2] = ib->inmsg[2];
116
0
        ib->outmsg[3] = ib->inmsg[3];
117
0
        ib->outmsg[4] = 0;
118
0
        ib->outmsg[5] = 1; /* Only support 1 outstanding request. */
119
0
        if (sizeof(ib->inmsg) > 0xff) { /* Input buffer size */
120
0
            ib->outmsg[6] = 0xff;
121
0
        } else {
122
0
            ib->outmsg[6] = (unsigned char) sizeof(ib->inmsg);
123
0
        }
124
0
        if (sizeof(ib->outmsg) > 0xff) { /* Output buffer size */
125
0
            ib->outmsg[7] = 0xff;
126
0
        } else {
127
0
            ib->outmsg[7] = (unsigned char) sizeof(ib->outmsg);
128
0
        }
129
0
        ib->outmsg[8] = 10; /* Max request to response time */
130
0
        ib->outmsg[9] = 0; /* Don't recommend retries */
131
0
        ib->outlen = 10;
132
0
        IPMI_BT_SET_BBUSY(ib->control_reg, 0);
133
0
        IPMI_BT_SET_B2H_ATN(ib->control_reg, 1);
134
0
        if (!IPMI_BT_GET_B2H_IRQ(ib->mask_reg) &&
135
0
                IPMI_BT_GET_B2H_IRQ_EN(ib->mask_reg)) {
136
0
            IPMI_BT_SET_B2H_IRQ(ib->mask_reg, 1);
137
0
            ipmi_bt_raise_irq(ib);
138
0
        }
139
0
        return;
140
0
    }
141
0
    ib->waiting_seq = ib->inmsg[2];
142
0
    ib->inmsg[2] = ib->inmsg[1];
143
0
    {
144
0
        IPMIBmcClass *bk = IPMI_BMC_GET_CLASS(ib->bmc);
145
0
        bk->handle_command(ib->bmc, ib->inmsg + 2, ib->inlen - 2,
146
0
                           sizeof(ib->inmsg), ib->waiting_rsp);
147
0
    }
148
0
}
149
150
static void ipmi_bt_handle_rsp(IPMIInterface *ii, uint8_t msg_id,
151
                                unsigned char *rsp, unsigned int rsp_len)
152
0
{
153
0
    IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
154
0
    IPMIBT *ib = iic->get_backend_data(ii);
155
156
0
    if (ib->waiting_rsp == msg_id) {
157
0
        ib->waiting_rsp++;
158
0
        if (rsp_len > (sizeof(ib->outmsg) - 2)) {
159
0
            ib->outmsg[0] = 4;
160
0
            ib->outmsg[1] = rsp[0];
161
0
            ib->outmsg[2] = ib->waiting_seq;
162
0
            ib->outmsg[3] = rsp[1];
163
0
            ib->outmsg[4] = IPMI_CC_CANNOT_RETURN_REQ_NUM_BYTES;
164
0
            ib->outlen = 5;
165
0
        } else {
166
0
            ib->outmsg[0] = rsp_len + 1;
167
0
            ib->outmsg[1] = rsp[0];
168
0
            ib->outmsg[2] = ib->waiting_seq;
169
0
            memcpy(ib->outmsg + 3, rsp + 1, rsp_len - 1);
170
0
            ib->outlen = rsp_len + 2;
171
0
        }
172
0
        IPMI_BT_SET_BBUSY(ib->control_reg, 0);
173
0
        IPMI_BT_SET_B2H_ATN(ib->control_reg, 1);
174
0
        if (!IPMI_BT_GET_B2H_IRQ(ib->mask_reg) &&
175
0
                IPMI_BT_GET_B2H_IRQ_EN(ib->mask_reg)) {
176
0
            IPMI_BT_SET_B2H_IRQ(ib->mask_reg, 1);
177
0
            ipmi_bt_raise_irq(ib);
178
0
        }
179
0
    }
180
0
}
181
182
183
static uint64_t ipmi_bt_ioport_read(void *opaque, hwaddr addr, unsigned size)
184
0
{
185
0
    IPMIInterface *ii = opaque;
186
0
    IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
187
0
    IPMIBT *ib = iic->get_backend_data(ii);
188
0
    uint32_t ret = 0xff;
189
190
0
    switch (addr & ib->size_mask) {
191
0
    case 0:
192
0
        ret = ib->control_reg;
193
0
        break;
194
0
    case 1:
195
0
        if (ib->outpos < ib->outlen) {
196
0
            ret = ib->outmsg[ib->outpos];
197
0
            ib->outpos++;
198
0
            if (ib->outpos == ib->outlen) {
199
0
                ib->outpos = 0;
200
0
                ib->outlen = 0;
201
0
            }
202
0
        } else {
203
0
            ret = 0xff;
204
0
        }
205
0
        break;
206
0
    case 2:
207
0
        ret = ib->mask_reg;
208
0
        break;
209
0
    default:
210
0
        ret = 0xff;
211
0
        break;
212
0
    }
213
0
    return ret;
214
0
}
215
216
static void ipmi_bt_signal(IPMIBT *ib, IPMIInterface *ii)
217
0
{
218
0
    IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
219
220
0
    ib->do_wake = 1;
221
0
    while (ib->do_wake) {
222
0
        ib->do_wake = 0;
223
0
        iic->handle_if_event(ii);
224
0
    }
225
0
}
226
227
static void ipmi_bt_ioport_write(void *opaque, hwaddr addr, uint64_t val,
228
                                 unsigned size)
229
0
{
230
0
    IPMIInterface *ii = opaque;
231
0
    IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
232
0
    IPMIBT *ib = iic->get_backend_data(ii);
233
234
0
    switch (addr & ib->size_mask) {
235
0
    case 0:
236
0
        if (IPMI_BT_GET_CLR_WR(val)) {
237
0
            ib->inlen = 0;
238
0
        }
239
0
        if (IPMI_BT_GET_CLR_RD(val)) {
240
0
            ib->outpos = 0;
241
0
        }
242
0
        if (IPMI_BT_GET_B2H_ATN(val)) {
243
0
            IPMI_BT_SET_B2H_ATN(ib->control_reg, 0);
244
0
        }
245
0
        if (IPMI_BT_GET_SMS_ATN(val)) {
246
0
            IPMI_BT_SET_SMS_ATN(ib->control_reg, 0);
247
0
        }
248
0
        if (IPMI_BT_GET_HBUSY(val)) {
249
            /* Toggle */
250
0
            IPMI_BT_SET_HBUSY(ib->control_reg,
251
0
                              !IPMI_BT_GET_HBUSY(ib->control_reg));
252
0
        }
253
0
        if (IPMI_BT_GET_H2B_ATN(val)) {
254
0
            IPMI_BT_SET_BBUSY(ib->control_reg, 1);
255
0
            ipmi_bt_signal(ib, ii);
256
0
        }
257
0
        break;
258
259
0
    case 1:
260
0
        if (ib->inlen < sizeof(ib->inmsg)) {
261
0
            ib->inmsg[ib->inlen] = val;
262
0
        }
263
0
        ib->inlen++;
264
0
        break;
265
266
0
    case 2:
267
0
        if (IPMI_BT_GET_B2H_IRQ_EN(val) !=
268
0
                        IPMI_BT_GET_B2H_IRQ_EN(ib->mask_reg)) {
269
0
            if (IPMI_BT_GET_B2H_IRQ_EN(val)) {
270
0
                if (IPMI_BT_GET_B2H_ATN(ib->control_reg) ||
271
0
                        IPMI_BT_GET_SMS_ATN(ib->control_reg)) {
272
0
                    IPMI_BT_SET_B2H_IRQ(ib->mask_reg, 1);
273
0
                    ipmi_bt_raise_irq(ib);
274
0
                }
275
0
                IPMI_BT_SET_B2H_IRQ_EN(ib->mask_reg, 1);
276
0
            } else {
277
0
                if (IPMI_BT_GET_B2H_IRQ(ib->mask_reg)) {
278
0
                    IPMI_BT_SET_B2H_IRQ(ib->mask_reg, 0);
279
0
                    ipmi_bt_lower_irq(ib);
280
0
                }
281
0
                IPMI_BT_SET_B2H_IRQ_EN(ib->mask_reg, 0);
282
0
            }
283
0
        }
284
0
        if (IPMI_BT_GET_B2H_IRQ(val) && IPMI_BT_GET_B2H_IRQ(ib->mask_reg)) {
285
0
            IPMI_BT_SET_B2H_IRQ(ib->mask_reg, 0);
286
0
            ipmi_bt_lower_irq(ib);
287
0
        }
288
0
        break;
289
0
    default:
290
        /* Ignore. */
291
0
        break;
292
0
    }
293
0
}
294
295
static const MemoryRegionOps ipmi_bt_io_ops = {
296
    .read = ipmi_bt_ioport_read,
297
    .write = ipmi_bt_ioport_write,
298
    .impl = {
299
        .min_access_size = 1,
300
        .max_access_size = 1,
301
    },
302
    .endianness = DEVICE_LITTLE_ENDIAN,
303
};
304
305
static void ipmi_bt_set_atn(IPMIInterface *ii, int val, int irq)
306
0
{
307
0
    IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
308
0
    IPMIBT *ib = iic->get_backend_data(ii);
309
310
0
    if (!!val == IPMI_BT_GET_SMS_ATN(ib->control_reg)) {
311
0
        return;
312
0
    }
313
314
0
    IPMI_BT_SET_SMS_ATN(ib->control_reg, val);
315
0
    if (val) {
316
0
        if (irq && !IPMI_BT_GET_B2H_ATN(ib->control_reg) &&
317
0
                IPMI_BT_GET_B2H_IRQ_EN(ib->mask_reg)) {
318
0
            IPMI_BT_SET_B2H_IRQ(ib->mask_reg, 1);
319
0
            ipmi_bt_raise_irq(ib);
320
0
        }
321
0
    } else {
322
0
        if (!IPMI_BT_GET_B2H_ATN(ib->control_reg) &&
323
0
                IPMI_BT_GET_B2H_IRQ(ib->mask_reg)) {
324
0
            IPMI_BT_SET_B2H_IRQ(ib->mask_reg, 0);
325
0
            ipmi_bt_lower_irq(ib);
326
0
        }
327
0
    }
328
0
}
329
330
static void ipmi_bt_handle_reset(IPMIInterface *ii, bool is_cold)
331
0
{
332
0
    IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
333
0
    IPMIBT *ib = iic->get_backend_data(ii);
334
335
0
    if (is_cold) {
336
        /* Disable the BT interrupt on reset */
337
0
        if (IPMI_BT_GET_B2H_IRQ(ib->mask_reg)) {
338
0
            IPMI_BT_SET_B2H_IRQ(ib->mask_reg, 0);
339
0
            ipmi_bt_lower_irq(ib);
340
0
        }
341
0
        IPMI_BT_SET_B2H_IRQ_EN(ib->mask_reg, 0);
342
0
    }
343
0
}
344
345
static void ipmi_bt_set_irq_enable(IPMIInterface *ii, int val)
346
0
{
347
0
    IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
348
0
    IPMIBT *ib = iic->get_backend_data(ii);
349
350
0
    ib->irqs_enabled = val;
351
0
}
352
353
static void ipmi_bt_init(IPMIInterface *ii, unsigned int min_size, Error **errp)
354
0
{
355
0
    IPMIInterfaceClass *iic = IPMI_INTERFACE_GET_CLASS(ii);
356
0
    IPMIBT *ib = iic->get_backend_data(ii);
357
358
0
    if (min_size == 0) {
359
0
        min_size = 4;
360
0
    }
361
0
    ib->size_mask = min_size - 1;
362
0
    ib->io_length = 3;
363
364
0
    memory_region_init_io(&ib->io, NULL, &ipmi_bt_io_ops, ii, "ipmi-bt",
365
0
                          min_size);
366
0
}
367
368
int ipmi_bt_vmstate_post_load(void *opaque, int version)
369
0
{
370
0
    IPMIBT *ib = opaque;
371
372
    /* Make sure all the values are sane. */
373
0
    if (ib->outpos >= MAX_IPMI_MSG_SIZE || ib->outlen >= MAX_IPMI_MSG_SIZE ||
374
0
        ib->outpos >= ib->outlen) {
375
0
        qemu_log_mask(LOG_GUEST_ERROR,
376
0
                      "ipmi:bt: vmstate transfer received bad out values: %d %d\n",
377
0
                      ib->outpos, ib->outlen);
378
0
        ib->outpos = 0;
379
0
        ib->outlen = 0;
380
0
    }
381
382
0
    if (ib->inlen >= MAX_IPMI_MSG_SIZE) {
383
0
        qemu_log_mask(LOG_GUEST_ERROR,
384
0
                      "ipmi:bt: vmstate transfer received bad in value: %d\n",
385
0
                      ib->inlen);
386
0
        ib->inlen = 0;
387
0
    }
388
389
0
    return 0;
390
0
}
391
392
const VMStateDescription vmstate_IPMIBT = {
393
    .name = TYPE_IPMI_INTERFACE_PREFIX "bt",
394
    .version_id = 1,
395
    .minimum_version_id = 1,
396
    .post_load = ipmi_bt_vmstate_post_load,
397
    .fields = (const VMStateField[]) {
398
        VMSTATE_BOOL(obf_irq_set, IPMIBT),
399
        VMSTATE_BOOL(atn_irq_set, IPMIBT),
400
        VMSTATE_BOOL(irqs_enabled, IPMIBT),
401
        VMSTATE_UINT32(outpos, IPMIBT),
402
        VMSTATE_UINT32(outlen, IPMIBT),
403
        VMSTATE_UINT8_ARRAY(outmsg, IPMIBT, MAX_IPMI_MSG_SIZE),
404
        VMSTATE_UINT32(inlen, IPMIBT),
405
        VMSTATE_UINT8_ARRAY(inmsg, IPMIBT, MAX_IPMI_MSG_SIZE),
406
        VMSTATE_UINT8(control_reg, IPMIBT),
407
        VMSTATE_UINT8(mask_reg, IPMIBT),
408
        VMSTATE_UINT8(waiting_rsp, IPMIBT),
409
        VMSTATE_UINT8(waiting_seq, IPMIBT),
410
        VMSTATE_END_OF_LIST()
411
    }
412
};
413
414
void ipmi_bt_get_fwinfo(struct IPMIBT *ib, IPMIFwInfo *info)
415
0
{
416
0
    info->interface_name = "bt";
417
0
    info->interface_type = IPMI_SMBIOS_BT;
418
0
    info->ipmi_spec_major_revision = 2;
419
0
    info->ipmi_spec_minor_revision = 0;
420
    /* BT System Interface Format, IPMI v1.5 */
421
0
    info->ipmi_channel_protocol = IPMI_CHANNEL_PROTOCOL_BT_15;
422
0
    info->base_address = ib->io_base;
423
0
    info->register_length = ib->io_length;
424
0
    info->register_spacing = 1;
425
0
    info->memspace = IPMI_MEMSPACE_IO;
426
0
    info->irq_type = IPMI_LEVEL_IRQ;
427
0
}
428
429
void ipmi_bt_class_init(IPMIInterfaceClass *iic)
430
122
{
431
122
    iic->init = ipmi_bt_init;
432
122
    iic->set_atn = ipmi_bt_set_atn;
433
122
    iic->handle_rsp = ipmi_bt_handle_rsp;
434
122
    iic->handle_if_event = ipmi_bt_handle_event;
435
122
    iic->set_irq_enable = ipmi_bt_set_irq_enable;
436
122
    iic->reset = ipmi_bt_handle_reset;
437
122
}