2 * IPMI KCS test cases, using the local interface.
4 * Copyright (c) 2012 Corey Minyard <cminyard@mvista.com>
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"
32 #define IPMI_KCS_BASE 0xca2
34 #define IPMI_KCS_STATUS_ABORT 0x60
35 #define IPMI_KCS_CMD_WRITE_START 0x61
36 #define IPMI_KCS_CMD_WRITE_END 0x62
37 #define IPMI_KCS_CMD_READ 0x68
39 #define IPMI_KCS_ABORTED_BY_CMD 0x01
41 #define IPMI_KCS_CMDREG_GET_STATE() ((kcs_get_cmdreg() >> 6) & 3)
42 #define IPMI_KCS_STATE_IDLE 0
43 #define IPMI_KCS_STATE_READ 1
44 #define IPMI_KCS_STATE_WRITE 2
45 #define IPMI_KCS_STATE_ERROR 3
46 #define IPMI_KCS_CMDREG_GET_CD() ((kcs_get_cmdreg() >> 3) & 1)
47 #define IPMI_KCS_CMDREG_GET_ATN() ((kcs_get_cmdreg() >> 2) & 1)
48 #define IPMI_KCS_CMDREG_GET_IBF() ((kcs_get_cmdreg() >> 1) & 1)
49 #define IPMI_KCS_CMDREG_GET_OBF() ((kcs_get_cmdreg() >> 0) & 1)
51 static int kcs_ints_enabled
;
53 static uint8_t kcs_get_cmdreg(void)
55 return inb(IPMI_KCS_BASE
+ 1);
58 static void kcs_write_cmdreg(uint8_t val
)
60 outb(IPMI_KCS_BASE
+ 1, val
);
63 static uint8_t kcs_get_datareg(void)
65 return inb(IPMI_KCS_BASE
);
68 static void kcs_write_datareg(uint8_t val
)
70 outb(IPMI_KCS_BASE
, val
);
73 static void kcs_wait_ibf(void)
75 unsigned int count
= 1000;
76 while (IPMI_KCS_CMDREG_GET_IBF() != 0) {
77 g_assert(--count
!= 0);
81 static void kcs_wait_obf(void)
83 unsigned int count
= 1000;
84 while (IPMI_KCS_CMDREG_GET_OBF() == 0) {
85 g_assert(--count
!= 0);
89 static void kcs_clear_obf(void)
91 if (kcs_ints_enabled
) {
92 g_assert(get_irq(IPMI_IRQ
));
94 g_assert(!get_irq(IPMI_IRQ
));
96 g_assert(IPMI_KCS_CMDREG_GET_OBF() == 1);
98 g_assert(IPMI_KCS_CMDREG_GET_OBF() == 0);
99 g_assert(!get_irq(IPMI_IRQ
));
102 static void kcs_check_state(uint8_t state
)
104 g_assert(IPMI_KCS_CMDREG_GET_STATE() == state
);
107 static void kcs_cmd(uint8_t *cmd
, unsigned int cmd_len
,
108 uint8_t *rsp
, unsigned int *rsp_len
)
110 unsigned int i
, j
= 0;
113 g_assert(kcs_get_cmdreg() == 0);
115 kcs_write_cmdreg(IPMI_KCS_CMD_WRITE_START
);
117 kcs_check_state(IPMI_KCS_STATE_WRITE
);
119 for (i
= 0; i
< cmd_len
; i
++) {
120 kcs_write_datareg(cmd
[i
]);
122 kcs_check_state(IPMI_KCS_STATE_WRITE
);
125 kcs_write_cmdreg(IPMI_KCS_CMD_WRITE_END
);
127 kcs_check_state(IPMI_KCS_STATE_WRITE
);
129 kcs_write_datareg(0);
132 switch (IPMI_KCS_CMDREG_GET_STATE()) {
133 case IPMI_KCS_STATE_READ
:
135 g_assert(j
< *rsp_len
);
136 rsp
[j
++] = kcs_get_datareg();
137 kcs_write_datareg(IPMI_KCS_CMD_READ
);
141 case IPMI_KCS_STATE_IDLE
:
152 static void kcs_abort(uint8_t *cmd
, unsigned int cmd_len
,
153 uint8_t *rsp
, unsigned int *rsp_len
)
155 unsigned int i
, j
= 0;
156 unsigned int retries
= 4;
159 g_assert(kcs_get_cmdreg() == 0);
161 kcs_write_cmdreg(IPMI_KCS_CMD_WRITE_START
);
163 kcs_check_state(IPMI_KCS_STATE_WRITE
);
165 for (i
= 0; i
< cmd_len
; i
++) {
166 kcs_write_datareg(cmd
[i
]);
168 kcs_check_state(IPMI_KCS_STATE_WRITE
);
171 kcs_write_cmdreg(IPMI_KCS_CMD_WRITE_END
);
173 kcs_check_state(IPMI_KCS_STATE_WRITE
);
175 kcs_write_datareg(0);
177 switch (IPMI_KCS_CMDREG_GET_STATE()) {
178 case IPMI_KCS_STATE_READ
:
180 g_assert(j
< *rsp_len
);
181 rsp
[j
++] = kcs_get_datareg();
182 kcs_write_datareg(IPMI_KCS_CMD_READ
);
189 /* Start the abort here */
191 g_assert(retries
> 0);
194 kcs_write_cmdreg(IPMI_KCS_STATUS_ABORT
);
197 kcs_write_datareg(0);
199 if (IPMI_KCS_CMDREG_GET_STATE() != IPMI_KCS_STATE_READ
) {
204 rsp
[0] = kcs_get_datareg();
205 kcs_write_datareg(IPMI_KCS_CMD_READ
);
207 if (IPMI_KCS_CMDREG_GET_STATE() != IPMI_KCS_STATE_IDLE
) {
218 static uint8_t get_dev_id_cmd
[] = { 0x18, 0x01 };
219 static uint8_t get_dev_id_rsp
[] = { 0x1c, 0x01, 0x00, 0x20, 0x00, 0x00, 0x00,
220 0x02, 0x07, 0x00, 0x00, 0x00, 0x00, 0x00 };
223 * Send a get_device_id to do a basic test.
225 static void test_kcs_base(void)
228 unsigned int rsplen
= sizeof(rsp
);
230 kcs_cmd(get_dev_id_cmd
, sizeof(get_dev_id_cmd
), rsp
, &rsplen
);
231 g_assert(rsplen
== sizeof(get_dev_id_rsp
));
232 g_assert(memcmp(get_dev_id_rsp
, rsp
, rsplen
) == 0);
236 * Abort a kcs operation while reading
238 static void test_kcs_abort(void)
241 unsigned int rsplen
= sizeof(rsp
);
243 kcs_abort(get_dev_id_cmd
, sizeof(get_dev_id_cmd
), rsp
, &rsplen
);
244 g_assert(rsp
[0] == IPMI_KCS_ABORTED_BY_CMD
);
247 static uint8_t set_bmc_globals_cmd
[] = { 0x18, 0x2e, 0x0f };
248 static uint8_t set_bmc_globals_rsp
[] = { 0x1c, 0x2e, 0x00 };
253 static void test_enable_irq(void)
256 unsigned int rsplen
= sizeof(rsp
);
258 kcs_cmd(set_bmc_globals_cmd
, sizeof(set_bmc_globals_cmd
), rsp
, &rsplen
);
259 g_assert(rsplen
== sizeof(set_bmc_globals_rsp
));
260 g_assert(memcmp(set_bmc_globals_rsp
, rsp
, rsplen
) == 0);
261 kcs_ints_enabled
= 1;
264 int main(int argc
, char **argv
)
270 g_test_init(&argc
, &argv
, NULL
);
272 cmdline
= g_strdup_printf("-device ipmi-bmc-sim,id=bmc0"
273 " -device isa-ipmi-kcs,bmc=bmc0");
274 qtest_start(cmdline
);
276 qtest_irq_intercept_in(global_qtest
, "ioapic");
277 qtest_add_func("/ipmi/local/kcs_base", test_kcs_base
);
278 qtest_add_func("/ipmi/local/kcs_abort", test_kcs_abort
);
279 qtest_add_func("/ipmi/local/kcs_enable_irq", test_enable_irq
);
280 qtest_add_func("/ipmi/local/kcs_base_irq", test_kcs_base
);
281 qtest_add_func("/ipmi/local/kcs_abort_irq", test_kcs_abort
);
283 qtest_quit(global_qtest
);