blob: 32c221fac7571373f082521c92b388d1f4a3100d [file] [log] [blame]
Andrew Jeffery0247c732020-02-06 11:48:52 +10301/* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later */
2
Andrew Jeffery2cda40f2020-02-28 15:26:20 +10303#ifdef HAVE_CONFIG_H
Andrew Jeffery0247c732020-02-06 11:48:52 +10304#include "config.h"
Andrew Jeffery2cda40f2020-02-28 15:26:20 +10305#endif
6
Andrew Jefferyeba19a32021-03-09 23:09:40 +10307#define ASTLPC_VER_CUR 3
Andrew Jefferydf5f6b92020-05-12 21:39:06 +09308#include "astlpc.c"
9
10#ifdef pr_fmt
11#undef pr_fmt
12#define pr_fmt(x) "test: " x
13#endif
14
Andrew Jeffery0247c732020-02-06 11:48:52 +103015#include "libmctp-astlpc.h"
16#include "libmctp-log.h"
Przemyslaw Czarnowskiff25d7e2020-03-26 11:39:37 +010017#include "container_of.h"
Andrew Jeffery0247c732020-02-06 11:48:52 +103018
19#ifdef NDEBUG
20#undef NDEBUG
21#endif
22
Andrew Jeffery0247c732020-02-06 11:48:52 +103023#include <assert.h>
Andrew Jeffery91f09ed2020-05-22 20:52:26 +093024#include <limits.h>
Andrew Jeffery0247c732020-02-06 11:48:52 +103025#include <stdint.h>
26#include <stdio.h>
27#include <stdlib.h>
28#include <string.h>
Andrew Jefferyc2b833e2020-10-28 14:28:37 +103029#include <sys/random.h>
Andrew Jeffery3f4bca92021-01-28 14:19:19 +103030#include <unistd.h>
Andrew Jeffery0247c732020-02-06 11:48:52 +103031
Andrew Jeffery91f09ed2020-05-22 20:52:26 +093032#ifndef ARRAY_SIZE
33#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
34#endif
35
Andrew Jeffery0247c732020-02-06 11:48:52 +103036struct mctp_binding_astlpc_mmio {
37 struct mctp_binding_astlpc astlpc;
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +093038 bool bmc;
Andrew Jeffery0247c732020-02-06 11:48:52 +103039
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +093040 uint8_t (*kcs)[2];
Andrew Jeffery0247c732020-02-06 11:48:52 +103041
42 size_t lpc_size;
43 uint8_t *lpc;
44};
45
Andrew Jeffery5a7c2db2020-05-22 20:13:42 +093046struct astlpc_endpoint {
47 struct mctp_binding_astlpc_mmio mmio;
48 struct mctp_binding_astlpc *astlpc;
49 struct mctp *mctp;
50};
51
52struct astlpc_test {
53 struct astlpc_endpoint bmc;
54 struct astlpc_endpoint host;
55 uint8_t kcs[2];
56 uint8_t *lpc_mem;
57
58 void *msg;
59 uint8_t count;
60};
61
62#define binding_to_mmio(b) \
Andrew Jeffery0247c732020-02-06 11:48:52 +103063 container_of(b, struct mctp_binding_astlpc_mmio, astlpc)
64
Andrew Jeffery53ea1472020-05-23 21:06:24 +093065static int mctp_astlpc_mmio_kcs_read(void *data,
66 enum mctp_binding_astlpc_kcs_reg reg,
67 uint8_t *val)
Andrew Jeffery0247c732020-02-06 11:48:52 +103068{
69 struct mctp_binding_astlpc_mmio *mmio = binding_to_mmio(data);
70
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +093071 *val = (*mmio->kcs)[reg];
Andrew Jeffery0247c732020-02-06 11:48:52 +103072
Andrew Jefferyd3c0bf02020-05-28 15:28:40 +093073 mctp_prdebug("%s: 0x%hhx from %s", __func__, *val,
74 reg ? "status" : "data");
Andrew Jeffery0247c732020-02-06 11:48:52 +103075
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +093076 if (reg == MCTP_ASTLPC_KCS_REG_DATA) {
77 uint8_t flag = mmio->bmc ? KCS_STATUS_IBF : KCS_STATUS_OBF;
78 (*mmio->kcs)[MCTP_ASTLPC_KCS_REG_STATUS] &= ~flag;
79 }
Andrew Jeffery0247c732020-02-06 11:48:52 +103080
81 return 0;
82}
83
Andrew Jeffery53ea1472020-05-23 21:06:24 +093084static int mctp_astlpc_mmio_kcs_write(void *data,
85 enum mctp_binding_astlpc_kcs_reg reg,
86 uint8_t val)
Andrew Jeffery0247c732020-02-06 11:48:52 +103087{
88 struct mctp_binding_astlpc_mmio *mmio = binding_to_mmio(data);
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +093089 uint8_t *regp;
Andrew Jeffery0247c732020-02-06 11:48:52 +103090
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +093091 assert(reg == MCTP_ASTLPC_KCS_REG_DATA ||
92 reg == MCTP_ASTLPC_KCS_REG_STATUS);
Andrew Jeffery0247c732020-02-06 11:48:52 +103093
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +093094 if (reg == MCTP_ASTLPC_KCS_REG_DATA) {
95 uint8_t flag = mmio->bmc ? KCS_STATUS_OBF : KCS_STATUS_IBF;
96 (*mmio->kcs)[MCTP_ASTLPC_KCS_REG_STATUS] |= flag;
97 }
98
99 regp = &(*mmio->kcs)[reg];
Andrew Jeffery0247c732020-02-06 11:48:52 +1030100 if (reg == MCTP_ASTLPC_KCS_REG_STATUS)
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930101 *regp = (val & ~0xbU) | (val & *regp & 1);
Andrew Jeffery0247c732020-02-06 11:48:52 +1030102 else
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930103 *regp = val;
Andrew Jeffery0247c732020-02-06 11:48:52 +1030104
Andrew Jefferyd3c0bf02020-05-28 15:28:40 +0930105 mctp_prdebug("%s: 0x%hhx to %s", __func__, val,
106 reg ? "status" : "data");
Andrew Jeffery0247c732020-02-06 11:48:52 +1030107
108 return 0;
109}
Andrew Jeffery85c04e42020-10-28 14:27:15 +1030110
111static const struct mctp_binding_astlpc_ops astlpc_direct_mmio_ops = {
112 .kcs_read = mctp_astlpc_mmio_kcs_read,
113 .kcs_write = mctp_astlpc_mmio_kcs_write,
114};
115
Andrew Jeffery06b2cd82020-03-17 23:12:27 +1030116int mctp_astlpc_mmio_lpc_read(void *data, void *buf, long offset, size_t len)
Andrew Jeffery0247c732020-02-06 11:48:52 +1030117{
118 struct mctp_binding_astlpc_mmio *mmio = binding_to_mmio(data);
119
Andrew Jeffery1dbf0212020-05-12 13:53:50 +0930120 mctp_prdebug("%s: %zu bytes from 0x%lx", __func__, len, offset);
121
Andrew Jeffery06b2cd82020-03-17 23:12:27 +1030122 assert(offset >= 0L);
Andrew Jeffery0247c732020-02-06 11:48:52 +1030123 assert(offset + len < mmio->lpc_size);
124
125 memcpy(buf, mmio->lpc + offset, len);
126
Andrew Jeffery0247c732020-02-06 11:48:52 +1030127 return 0;
128}
129
Andrew Jeffery55fb90b2020-05-12 13:54:37 +0930130int mctp_astlpc_mmio_lpc_write(void *data, const void *buf, long offset,
131 size_t len)
Andrew Jeffery0247c732020-02-06 11:48:52 +1030132{
133 struct mctp_binding_astlpc_mmio *mmio = binding_to_mmio(data);
134
Andrew Jeffery1dbf0212020-05-12 13:53:50 +0930135 mctp_prdebug("%s: %zu bytes to 0x%lx", __func__, len, offset);
136
Andrew Jeffery06b2cd82020-03-17 23:12:27 +1030137 assert(offset >= 0L);
Andrew Jeffery0247c732020-02-06 11:48:52 +1030138 assert(offset + len < mmio->lpc_size);
139
140 memcpy(mmio->lpc + offset, buf, len);
141
Andrew Jeffery0247c732020-02-06 11:48:52 +1030142 return 0;
143}
144
Andrew Jeffery85c04e42020-10-28 14:27:15 +1030145static const struct mctp_binding_astlpc_ops astlpc_indirect_mmio_ops = {
146 .kcs_read = mctp_astlpc_mmio_kcs_read,
147 .kcs_write = mctp_astlpc_mmio_kcs_write,
148 .lpc_read = mctp_astlpc_mmio_lpc_read,
149 .lpc_write = mctp_astlpc_mmio_lpc_write,
150};
151
Andrew Jefferyb93b6112020-06-05 14:13:44 +0930152#define __unused __attribute__((unused))
153
154static void rx_message(uint8_t eid __unused, void *data __unused, void *msg,
155 size_t len)
Andrew Jeffery0247c732020-02-06 11:48:52 +1030156{
Andrew Jeffery5a7c2db2020-05-22 20:13:42 +0930157 struct astlpc_test *test = data;
Andrew Jeffery0247c732020-02-06 11:48:52 +1030158
Andrew Jeffery5a7c2db2020-05-22 20:13:42 +0930159 mctp_prdebug("MCTP message received: msg: %p, len %zd", msg, len);
Andrew Jeffery0247c732020-02-06 11:48:52 +1030160
Andrew Jeffery5a7c2db2020-05-22 20:13:42 +0930161 assert(len > 0);
162 assert(msg);
163 assert(test);
164 assert(test->msg);
165 assert(!memcmp(test->msg, msg, len));
166
167 test->count++;
Andrew Jeffery0247c732020-02-06 11:48:52 +1030168}
169
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930170static int endpoint_init(struct astlpc_endpoint *ep, mctp_eid_t eid,
Andrew Jefferya9368982020-06-09 13:07:39 +0930171 uint8_t mode, uint32_t mtu, uint8_t (*kcs)[2],
172 void *lpc_mem)
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930173{
174 /*
175 * Configure the direction of the KCS interface so we know whether to
176 * set or clear IBF or OBF on writes or reads.
177 */
178 ep->mmio.bmc = (mode == MCTP_BINDING_ASTLPC_MODE_BMC);
179
180 ep->mctp = mctp_init();
181 assert(ep->mctp);
182
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930183 /* Inject KCS registers */
184 ep->mmio.kcs = kcs;
185
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930186 /* Initialise the binding */
Andrew Jefferya9368982020-06-09 13:07:39 +0930187 ep->astlpc = mctp_astlpc_init(mode, mtu, lpc_mem,
Andrew Jeffery55fb90b2020-05-12 13:54:37 +0930188 &astlpc_direct_mmio_ops, &ep->mmio);
Andrew Jeffery3a540662020-05-26 19:55:30 +0930189 assert(ep->astlpc);
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930190
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930191 return mctp_register_bus(ep->mctp, &ep->astlpc->binding, eid);
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930192}
193
194static void endpoint_destroy(struct astlpc_endpoint *ep)
195{
196 mctp_astlpc_destroy(ep->astlpc);
197 mctp_destroy(ep->mctp);
198}
199
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930200static void network_init(struct astlpc_test *ctx)
201{
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930202 int rc;
203
Andrew Jeffery55fb90b2020-05-12 13:54:37 +0930204 ctx->lpc_mem = calloc(1, 1 * 1024 * 1024);
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930205 assert(ctx->lpc_mem);
206
207 /* BMC initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930208 rc = endpoint_init(&ctx->bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930209 &ctx->kcs, ctx->lpc_mem);
210 assert(!rc);
Andrew Jeffery3f325072020-05-28 09:19:51 +0930211 assert(ctx->kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_BMC_READY);
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930212
213 /* Host initialisation */
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930214 rc = endpoint_init(&ctx->host, 9, MCTP_BINDING_ASTLPC_MODE_HOST,
Andrew Jefferya9368982020-06-09 13:07:39 +0930215 MCTP_BTU, &ctx->kcs, ctx->lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930216 assert(!rc);
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930217
218 /* BMC processes host channel init request, alerts host */
219 mctp_astlpc_poll(ctx->bmc.astlpc);
Andrew Jeffery3f325072020-05-28 09:19:51 +0930220 assert(ctx->kcs[MCTP_ASTLPC_KCS_REG_STATUS] &
221 KCS_STATUS_CHANNEL_ACTIVE);
222 assert(ctx->kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0xff);
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930223
224 /* Host dequeues channel init result */
225 mctp_astlpc_poll(ctx->host.astlpc);
226}
227
228static void network_destroy(struct astlpc_test *ctx)
229{
230 endpoint_destroy(&ctx->bmc);
231 endpoint_destroy(&ctx->host);
232 free(ctx->lpc_mem);
233}
234
Andrew Jeffery129ef932020-05-22 16:24:19 +0930235static void astlpc_assert_tx_packet(struct astlpc_endpoint *src,
236 const void *expected, size_t len)
237{
238 const size_t tx_body = src->astlpc->layout.tx.offset + 4 + 4;
239 const void *test = ((char *)src->astlpc->lpc_map) + tx_body;
240 assert(!memcmp(test, expected, len));
241}
242
Andrew Jefferye756de82020-05-22 12:30:58 +0930243static void astlpc_test_packetised_message_bmc_to_host(void)
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930244{
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930245 struct astlpc_test ctx = { 0 };
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930246 uint8_t msg[2 * MCTP_BTU];
Andrew Jeffery0247c732020-02-06 11:48:52 +1030247 int rc;
248
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930249 /* Test harness initialisation */
250
Andrew Jeffery5a7c2db2020-05-22 20:13:42 +0930251 network_init(&ctx);
252
Andrew Jeffery0247c732020-02-06 11:48:52 +1030253 memset(&msg[0], 0x5a, MCTP_BTU);
254 memset(&msg[MCTP_BTU], 0xa5, MCTP_BTU);
255
Andrew Jeffery5a7c2db2020-05-22 20:13:42 +0930256 ctx.msg = &msg[0];
257 ctx.count = 0;
258 mctp_set_rx_all(ctx.host.mctp, rx_message, &ctx);
Andrew Jeffery0247c732020-02-06 11:48:52 +1030259
260 /* BMC sends a message */
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930261 rc = mctp_message_tx(ctx.bmc.mctp, 9, msg, sizeof(msg));
Andrew Jeffery0247c732020-02-06 11:48:52 +1030262 assert(rc == 0);
Andrew Jefferyd5e3cd72020-05-12 22:10:22 +0930263
Andrew Jeffery129ef932020-05-22 16:24:19 +0930264 /* Host receives the first packet */
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930265 mctp_astlpc_poll(ctx.host.astlpc);
Andrew Jeffery0247c732020-02-06 11:48:52 +1030266
Andrew Jeffery0247c732020-02-06 11:48:52 +1030267 /* BMC dequeues ownership hand-over and sends the queued packet */
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930268 rc = mctp_astlpc_poll(ctx.bmc.astlpc);
Andrew Jeffery0247c732020-02-06 11:48:52 +1030269 assert(rc == 0);
270
Andrew Jeffery129ef932020-05-22 16:24:19 +0930271 /* Host receives the next packet */
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930272 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_OBF);
273 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x01);
Andrew Jeffery0247c732020-02-06 11:48:52 +1030274
Andrew Jeffery129ef932020-05-22 16:24:19 +0930275 astlpc_assert_tx_packet(&ctx.bmc, &msg[MCTP_BTU], MCTP_BTU);
Andrew Jeffery0247c732020-02-06 11:48:52 +1030276
Andrew Jeffery5a7c2db2020-05-22 20:13:42 +0930277 /* Host receives final packet */
278 mctp_astlpc_poll(ctx.host.astlpc);
279 assert(ctx.count == 1);
280
Andrew Jefferycb5d55c2020-05-22 13:26:27 +0930281 network_destroy(&ctx);
Andrew Jefferye756de82020-05-22 12:30:58 +0930282}
283
Andrew Jefferyec9a0062020-05-22 21:21:55 +0930284static void astlpc_test_simple_message_host_to_bmc(void)
285{
286 struct astlpc_test ctx = { 0 };
287 uint8_t msg[MCTP_BTU];
288 int rc;
289
290 /* Test harness initialisation */
291
292 network_init(&ctx);
293
294 memset(&msg[0], 0xa5, MCTP_BTU);
295
296 ctx.msg = &msg[0];
297 ctx.count = 0;
298 mctp_set_rx_all(ctx.bmc.mctp, rx_message, &ctx);
299
300 /* Host sends the single-packet message */
301 rc = mctp_message_tx(ctx.host.mctp, 8, msg, sizeof(msg));
302 assert(rc == 0);
303 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_IBF);
304 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x01);
305
306 astlpc_assert_tx_packet(&ctx.host, &msg[0], MCTP_BTU);
307
308 /* BMC receives the single-packet message */
309 mctp_astlpc_poll(ctx.bmc.astlpc);
310 assert(ctx.count == 1);
311
312 /* BMC returns Tx area ownership to Host */
313 assert(!(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_IBF));
314 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x02);
315 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_OBF);
316
317 /* Host dequeues ownership hand-over and sends the queued packet */
318 rc = mctp_astlpc_poll(ctx.host.astlpc);
319 assert(rc == 0);
320
321 network_destroy(&ctx);
322}
323
Andrew Jeffery8f3eb722020-05-22 20:23:49 +0930324static void astlpc_test_simple_message_bmc_to_host(void)
325{
326 struct astlpc_test ctx = { 0 };
327 uint8_t msg[MCTP_BTU];
328 int rc;
329
330 /* Test harness initialisation */
331
332 network_init(&ctx);
333
334 memset(&msg[0], 0x5a, MCTP_BTU);
335
336 ctx.msg = &msg[0];
337 ctx.count = 0;
338 mctp_set_rx_all(ctx.host.mctp, rx_message, &ctx);
339
340 /* BMC sends the single-packet message */
341 rc = mctp_message_tx(ctx.bmc.mctp, 9, msg, sizeof(msg));
342 assert(rc == 0);
343 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_OBF);
344 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x01);
345
346 astlpc_assert_tx_packet(&ctx.bmc, &msg[0], MCTP_BTU);
347
348 /* Host receives the single-packet message */
349 mctp_astlpc_poll(ctx.host.astlpc);
350 assert(ctx.count == 1);
351
352 /* Host returns Rx area ownership to BMC */
353 assert(!(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_OBF));
354 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x02);
355 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_IBF);
356
357 /* BMC dequeues ownership hand-over and sends the queued packet */
358 rc = mctp_astlpc_poll(ctx.bmc.astlpc);
359 assert(rc == 0);
360
361 network_destroy(&ctx);
362}
363
Andrew Jefferyf1cdb162020-05-23 21:25:21 +0930364static void astlpc_test_host_before_bmc(void)
365{
366 struct mctp_binding_astlpc_mmio mmio = { 0 };
367 struct mctp_binding_astlpc *astlpc;
368 uint8_t kcs[2] = { 0 };
369 struct mctp *mctp;
370 int rc;
371
372 mctp = mctp_init();
373 assert(mctp);
374
375 /* Inject KCS registers */
376 mmio.kcs = &kcs;
377
378 /* Initialise the binding */
379 astlpc = mctp_astlpc_init(MCTP_BINDING_ASTLPC_MODE_HOST, MCTP_BTU, NULL,
Andrew Jeffery55fb90b2020-05-12 13:54:37 +0930380 &astlpc_direct_mmio_ops, &mmio);
Andrew Jefferyf1cdb162020-05-23 21:25:21 +0930381
382 /* Register the binding to trigger the start-up sequence */
383 rc = mctp_register_bus(mctp, &astlpc->binding, 8);
384
385 /* Start-up should fail as we haven't initialised the BMC */
386 assert(rc < 0);
387
388 mctp_astlpc_destroy(astlpc);
389 mctp_destroy(mctp);
390}
391
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930392static void astlpc_test_bad_version(void)
393{
394 assert(0 ==
395 mctp_astlpc_negotiate_version(ASTLPC_VER_BAD, ASTLPC_VER_CUR,
396 ASTLPC_VER_MIN, ASTLPC_VER_CUR));
397 assert(0 ==
398 mctp_astlpc_negotiate_version(ASTLPC_VER_MIN, ASTLPC_VER_BAD,
399 ASTLPC_VER_MIN, ASTLPC_VER_CUR));
400 assert(0 ==
401 mctp_astlpc_negotiate_version(ASTLPC_VER_MIN, ASTLPC_VER_CUR,
402 ASTLPC_VER_BAD, ASTLPC_VER_CUR));
403 assert(0 ==
404 mctp_astlpc_negotiate_version(ASTLPC_VER_MIN, ASTLPC_VER_CUR,
405 ASTLPC_VER_MIN, ASTLPC_VER_BAD));
406 assert(0 == mctp_astlpc_negotiate_version(
407 ASTLPC_VER_CUR + 1, ASTLPC_VER_CUR, ASTLPC_VER_MIN,
408 ASTLPC_VER_CUR + 1));
409 assert(0 == mctp_astlpc_negotiate_version(
410 ASTLPC_VER_MIN, ASTLPC_VER_CUR + 1,
411 ASTLPC_VER_CUR + 1, ASTLPC_VER_CUR));
412}
413
414static void astlpc_test_incompatible_versions(void)
415{
416 assert(0 == mctp_astlpc_negotiate_version(
417 ASTLPC_VER_CUR, ASTLPC_VER_CUR, ASTLPC_VER_CUR + 1,
418 ASTLPC_VER_CUR + 1));
419 assert(0 == mctp_astlpc_negotiate_version(
420 ASTLPC_VER_CUR + 1, ASTLPC_VER_CUR + 1,
421 ASTLPC_VER_CUR, ASTLPC_VER_CUR));
422}
423
424static void astlpc_test_choose_bmc_ver_cur(void)
425{
426 assert(2 == mctp_astlpc_negotiate_version(1, 2, 2, 3));
427}
428
429static void astlpc_test_choose_host_ver_cur(void)
430{
431 assert(2 == mctp_astlpc_negotiate_version(2, 3, 1, 2));
432}
433
434static void astlpc_test_version_host_fails_negotiation(void)
Andrew Jefferyf1a21312020-05-22 12:48:21 +0930435{
436 struct astlpc_endpoint bmc, host;
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930437 struct mctp_lpcmap_hdr *hdr;
Andrew Jefferyf1a21312020-05-22 12:48:21 +0930438 uint8_t kcs[2] = { 0 };
Andrew Jefferyf1a21312020-05-22 12:48:21 +0930439 void *lpc_mem;
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930440 int rc;
Andrew Jefferyf1a21312020-05-22 12:48:21 +0930441
442 /* Test harness initialisation */
Andrew Jeffery55fb90b2020-05-12 13:54:37 +0930443 lpc_mem = calloc(1, 1 * 1024 * 1024);
Andrew Jefferyf1a21312020-05-22 12:48:21 +0930444 assert(lpc_mem);
445
Andrew Jeffery8f3eb722020-05-22 20:23:49 +0930446 /* BMC initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930447 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
448 &kcs, lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930449 assert(!rc);
450
451 /* Now the BMC is initialised, break its version announcement */
452 hdr = lpc_mem;
453 hdr->bmc_ver_cur = ASTLPC_VER_BAD;
454
455 /* Host initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930456 rc = endpoint_init(&host, 9, MCTP_BINDING_ASTLPC_MODE_HOST, MCTP_BTU,
457 &kcs, lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930458 assert(rc < 0);
459
460 endpoint_destroy(&bmc);
461 endpoint_destroy(&host);
462 free(lpc_mem);
463}
464
465static void astlpc_test_version_bmc_fails_negotiation(void)
466{
467 struct astlpc_endpoint bmc, host;
468 struct mctp_lpcmap_hdr *hdr;
469 uint8_t kcs[2] = { 0 };
470 void *lpc_mem;
471 int rc;
472
473 /* Test harness initialisation */
474 lpc_mem = calloc(1, 1 * 1024 * 1024);
475 assert(lpc_mem);
476
477 /* BMC initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930478 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
479 &kcs, lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930480 assert(!rc);
481
482 /* Host initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930483 rc = endpoint_init(&host, 9, MCTP_BINDING_ASTLPC_MODE_HOST, MCTP_BTU,
484 &kcs, lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930485 assert(!rc);
486
487 /* Now the host is initialised, break its version announcement */
488 hdr = lpc_mem;
489 hdr->host_ver_cur = ASTLPC_VER_BAD;
490
491 /* Poll the BMC to detect the broken host version */
492 mctp_astlpc_poll(bmc.astlpc);
493 assert(!(kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_CHANNEL_ACTIVE));
494
495 /* Poll the host so it detects failed negotiation */
496 rc = mctp_astlpc_poll(host.astlpc);
497 assert(rc < 0);
498
499 endpoint_destroy(&bmc);
500 endpoint_destroy(&host);
501 free(lpc_mem);
502}
503
504static void astlpc_test_simple_init(void)
505{
506 struct astlpc_endpoint bmc, host;
507 uint8_t kcs[2] = { 0 };
508 void *lpc_mem;
509 int rc;
510
511 /* Test harness initialisation */
512 lpc_mem = calloc(1, 1 * 1024 * 1024);
513 assert(lpc_mem);
514
515 /* BMC initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930516 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
517 &kcs, lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930518 assert(!rc);
Andrew Jefferyf1a21312020-05-22 12:48:21 +0930519
520 /* Verify the BMC binding was initialised */
521 assert(kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_BMC_READY);
522
Andrew Jeffery8f3eb722020-05-22 20:23:49 +0930523 /* Host initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930524 rc = endpoint_init(&host, 9, MCTP_BINDING_ASTLPC_MODE_HOST, MCTP_BTU,
525 &kcs, lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930526 assert(!rc);
Andrew Jefferyf1a21312020-05-22 12:48:21 +0930527
528 /* Host sends channel init command */
529 assert(kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_IBF);
530 assert(kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x00);
531
532 /* BMC receives host channel init request */
533 mctp_astlpc_poll(bmc.astlpc);
534
535 /* BMC sends init response */
536 assert(kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_OBF);
537 assert(kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_CHANNEL_ACTIVE);
538 assert(kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0xff);
539
540 /* Host dequeues data */
541 mctp_astlpc_poll(host.astlpc);
542
543 endpoint_destroy(&bmc);
544 endpoint_destroy(&host);
545 free(lpc_mem);
546}
547
Andrew Jeffery55fb90b2020-05-12 13:54:37 +0930548static void astlpc_test_simple_indirect_message_bmc_to_host(void)
549{
550 struct astlpc_test ctx = { 0 };
551 uint8_t kcs[2] = { 0 };
552 uint8_t msg[MCTP_BTU];
553 int rc;
554
555 ctx.lpc_mem = calloc(1, LPC_WIN_SIZE);
556 assert(ctx.lpc_mem);
557
558 /* Test message data */
559 memset(&msg[0], 0x5a, MCTP_BTU);
560
561 /* Manually set up the network so we can inject the indirect ops */
562
563 /* BMC initialisation */
564 ctx.bmc.mmio.bmc = true;
565 ctx.bmc.mctp = mctp_init();
566 assert(ctx.bmc.mctp);
567 ctx.bmc.mmio.kcs = &kcs;
568 ctx.bmc.mmio.lpc = ctx.lpc_mem;
569 ctx.bmc.mmio.lpc_size = LPC_WIN_SIZE;
570 ctx.bmc.astlpc =
571 mctp_astlpc_init(MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU, NULL,
572 &astlpc_indirect_mmio_ops, &ctx.bmc.mmio);
573 mctp_register_bus(ctx.bmc.mctp, &ctx.bmc.astlpc->binding, 8);
574
575 /* Host initialisation */
576 ctx.host.mmio.bmc = false;
577 ctx.host.mctp = mctp_init();
578 assert(ctx.host.mctp);
579 ctx.host.mmio.kcs = &kcs;
580 ctx.host.mmio.lpc = ctx.lpc_mem;
581 ctx.host.mmio.lpc_size = LPC_WIN_SIZE;
582 ctx.host.astlpc =
583 mctp_astlpc_init(MCTP_BINDING_ASTLPC_MODE_HOST, MCTP_BTU, NULL,
584 &astlpc_indirect_mmio_ops, &ctx.host.mmio);
585 mctp_register_bus(ctx.host.mctp, &ctx.host.astlpc->binding, 9);
586
587 /* BMC processes host channel init request, alerts host */
588 mctp_astlpc_poll(ctx.bmc.astlpc);
589
590 /* Host dequeues channel init result */
591 mctp_astlpc_poll(ctx.host.astlpc);
592
593 ctx.msg = &msg[0];
594 ctx.count = 0;
595 mctp_set_rx_all(ctx.host.mctp, rx_message, &ctx);
596
597 /* BMC sends the single-packet message */
598 rc = mctp_message_tx(ctx.bmc.mctp, 9, msg, sizeof(msg));
599 assert(rc == 0);
600
601 /* Host receives the single-packet message */
602 rc = mctp_astlpc_poll(ctx.host.astlpc);
603 assert(rc == 0);
604 assert(ctx.count == 1);
605
606 /* BMC dequeues ownership hand-over and sends the queued packet */
607 rc = mctp_astlpc_poll(ctx.bmc.astlpc);
608 assert(rc == 0);
609
610 /* Can still tear-down the network in the normal fashion */
611 network_destroy(&ctx);
612}
613
Andrew Jefferyd0f5da02020-05-28 09:12:55 +0930614static void astlpc_test_host_tx_bmc_gone(void)
615{
616 struct astlpc_test ctx = { 0 };
617 uint8_t unwritten[MCTP_BTU];
618 uint8_t msg[MCTP_BTU];
619 int rc;
620
621 /* Test harness initialisation */
622
623 network_init(&ctx);
624
625 memset(&msg[0], 0x5a, sizeof(msg));
626 memset(&unwritten[0], 0, sizeof(unwritten));
627
628 ctx.msg = &msg[0];
629 ctx.count = 0;
630
631 /* Clear bmc-ready */
632 endpoint_destroy(&ctx.bmc);
633
634 /* Host detects that the BMC is disabled */
635 mctp_astlpc_poll(ctx.host.astlpc);
636
637 /* Host attempts to send the single-packet message, but is prevented */
638 rc = mctp_message_tx(ctx.host.mctp, 8, msg, sizeof(msg));
639 assert(rc == 0);
640 assert(!(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_OBF));
641 astlpc_assert_tx_packet(&ctx.host, &unwritten[0], MCTP_BTU);
642
643 /* BMC comes back */
Andrew Jefferya9368982020-06-09 13:07:39 +0930644 rc = endpoint_init(&ctx.bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
645 &ctx.kcs, ctx.lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930646 assert(!rc);
Andrew Jefferyd0f5da02020-05-28 09:12:55 +0930647 mctp_set_rx_all(ctx.bmc.mctp, rx_message, &ctx);
648
649 /* Host triggers channel init */
650 mctp_astlpc_poll(ctx.host.astlpc);
651
652 /* BMC handles channel init */
653 mctp_astlpc_poll(ctx.bmc.astlpc);
654
655 /* Host completes channel init, flushing the Tx queue */
656 mctp_astlpc_poll(ctx.host.astlpc);
657
658 /* BMC receives the single-packet message */
659 mctp_astlpc_poll(ctx.bmc.astlpc);
660 assert(ctx.count == 1);
661
662 network_destroy(&ctx);
663}
664
Andrew Jefferyf3d94dc2020-05-28 10:50:18 +0930665static void astlpc_test_poll_not_ready(void)
666{
667 struct astlpc_endpoint bmc;
668 uint8_t kcs[2] = { 0 };
669 void *lpc_mem;
670 int rc;
671
672 /* Test harness initialisation */
673 lpc_mem = calloc(1, 1 * 1024 * 1024);
674 assert(lpc_mem);
675
676 /* BMC initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930677 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
678 &kcs, lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930679 assert(!rc);
Andrew Jefferyf3d94dc2020-05-28 10:50:18 +0930680
681 /* Check for a command despite none present */
682 rc = mctp_astlpc_poll(bmc.astlpc);
683
684 /* Make sure it doesn't fail */
685 assert(rc == 0);
686
687 endpoint_destroy(&bmc);
688 free(lpc_mem);
689}
690
Andrew Jeffery67655e82020-05-28 10:51:27 +0930691static void astlpc_test_undefined_command(void)
692{
693 struct astlpc_endpoint bmc;
694 uint8_t kcs[2] = { 0 };
695 void *lpc_mem;
696 int rc;
697
698 /* Test harness initialisation */
699 lpc_mem = calloc(1, 1 * 1024 * 1024);
700 assert(lpc_mem);
701
702 /* BMC initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930703 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
704 &kcs, lpc_mem);
Andrew Jeffery4e8264b2020-05-23 20:34:33 +0930705 assert(!rc);
Andrew Jeffery67655e82020-05-28 10:51:27 +0930706
707 /* 0x5a isn't legal in v1 or v2 */
708 kcs[MCTP_ASTLPC_KCS_REG_DATA] = 0x5a;
709 kcs[MCTP_ASTLPC_KCS_REG_STATUS] |= KCS_STATUS_IBF;
710
711 /* Check for a command despite none present */
712 rc = mctp_astlpc_poll(bmc.astlpc);
713
714 /* Make sure it doesn't fail, bad command should be discarded */
715 assert(rc == 0);
716
717 endpoint_destroy(&bmc);
718 free(lpc_mem);
719}
720
Andrew Jefferyeba19a32021-03-09 23:09:40 +1030721#define BUFFER_MIN (MCTP_PACKET_SIZE(MCTP_BTU) + 4 + 4)
Andrew Jeffery88412be2021-03-09 22:05:22 +1030722static const struct mctp_binding_astlpc astlpc_layout_ctx = {
Andrew Jefferyeba19a32021-03-09 23:09:40 +1030723 .proto = &astlpc_protocol_version[3],
Andrew Jeffery88412be2021-03-09 22:05:22 +1030724};
Andrew Jeffery3a540662020-05-26 19:55:30 +0930725
726static void astlpc_test_buffers_rx_offset_overflow(void)
727{
728 struct mctp_astlpc_layout l = {
729 .rx = { UINT32_MAX, BUFFER_MIN },
730 .tx = { control_size, BUFFER_MIN },
731 };
732
Andrew Jeffery88412be2021-03-09 22:05:22 +1030733 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930734}
735
736static void astlpc_test_buffers_tx_offset_overflow(void)
737{
738 struct mctp_astlpc_layout l = {
739 .rx = { control_size, BUFFER_MIN },
740 .tx = { UINT32_MAX, BUFFER_MIN },
741 };
742
Andrew Jeffery88412be2021-03-09 22:05:22 +1030743 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930744}
745
746static void astlpc_test_buffers_rx_size_overflow(void)
747{
748 struct mctp_astlpc_layout l = {
749 .rx = { control_size + BUFFER_MIN, UINT32_MAX },
750 .tx = { control_size, BUFFER_MIN },
751 };
752
Andrew Jeffery88412be2021-03-09 22:05:22 +1030753 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930754}
755
756static void astlpc_test_buffers_tx_size_overflow(void)
757{
758 struct mctp_astlpc_layout l = {
759 .rx = { control_size, BUFFER_MIN },
760 .tx = { control_size + BUFFER_MIN, UINT32_MAX },
761 };
762
Andrew Jeffery88412be2021-03-09 22:05:22 +1030763 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930764}
765
766static void astlpc_test_buffers_rx_window_violation(void)
767{
768 struct mctp_astlpc_layout l = {
769 .rx = { LPC_WIN_SIZE - BUFFER_MIN + 1, BUFFER_MIN },
770 .tx = { control_size, BUFFER_MIN },
771 };
772
Andrew Jeffery88412be2021-03-09 22:05:22 +1030773 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930774}
775
776static void astlpc_test_buffers_tx_window_violation(void)
777{
778 struct mctp_astlpc_layout l = {
779 .rx = { control_size, BUFFER_MIN },
780 .tx = { LPC_WIN_SIZE - BUFFER_MIN + 1, BUFFER_MIN },
781 };
782
Andrew Jeffery88412be2021-03-09 22:05:22 +1030783 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930784}
785
786static void astlpc_test_buffers_rx_size_fails_btu(void)
787{
788 struct mctp_astlpc_layout l = {
789 .rx = { control_size, BUFFER_MIN - 1 },
790 .tx = { control_size + BUFFER_MIN, BUFFER_MIN },
791 };
792
Andrew Jeffery88412be2021-03-09 22:05:22 +1030793 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930794}
795
796static void astlpc_test_buffers_tx_size_fails_btu(void)
797{
798 struct mctp_astlpc_layout l = {
799 .rx = { control_size, BUFFER_MIN },
800 .tx = { control_size + BUFFER_MIN, BUFFER_MIN - 1 },
801 };
802
Andrew Jeffery88412be2021-03-09 22:05:22 +1030803 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930804}
805
806static void astlpc_test_buffers_overlap_rx_low(void)
807{
808 struct mctp_astlpc_layout l = {
809 .rx = { control_size, 2 * BUFFER_MIN },
810 .tx = { control_size + BUFFER_MIN, 2 * BUFFER_MIN },
811 };
812
Andrew Jeffery88412be2021-03-09 22:05:22 +1030813 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930814}
815
816static void astlpc_test_buffers_overlap_tx_low(void)
817{
818 struct mctp_astlpc_layout l = {
819 .rx = { control_size + BUFFER_MIN, 2 * BUFFER_MIN },
820 .tx = { control_size, 2 * BUFFER_MIN },
821 };
822
Andrew Jeffery88412be2021-03-09 22:05:22 +1030823 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930824}
825
826static void astlpc_test_buffers_overlap_exact(void)
827{
828 struct mctp_astlpc_layout l = {
829 .rx = { control_size, 2 * BUFFER_MIN },
830 .tx = { control_size, 2 * BUFFER_MIN },
831 };
832
Andrew Jeffery88412be2021-03-09 22:05:22 +1030833 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930834}
835
836static void astlpc_test_buffers_overlap_control(void)
837{
838 struct mctp_astlpc_layout l = {
839 .rx = { 0, BUFFER_MIN },
840 .tx = { control_size + BUFFER_MIN, BUFFER_MIN },
841 };
842
Andrew Jeffery88412be2021-03-09 22:05:22 +1030843 assert(!mctp_astlpc_layout_validate(&astlpc_layout_ctx, &l));
Andrew Jeffery3a540662020-05-26 19:55:30 +0930844}
845
846static void astlpc_test_buffers_bad_host_proposal(void)
847{
848 struct astlpc_endpoint bmc, host;
849 struct mctp_lpcmap_hdr *hdr;
850 uint8_t kcs[2] = { 0 };
851 void *lpc_mem;
Andrew Jefferya9368982020-06-09 13:07:39 +0930852 int rc;
Andrew Jeffery3a540662020-05-26 19:55:30 +0930853
854 /* Test harness initialisation */
855 lpc_mem = calloc(1, 1 * 1024 * 1024);
856 assert(lpc_mem);
857
858 /* BMC initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930859 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
860 &kcs, lpc_mem);
861 assert(!rc);
Andrew Jeffery3a540662020-05-26 19:55:30 +0930862
863 /* Host initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930864 rc = endpoint_init(&host, 9, MCTP_BINDING_ASTLPC_MODE_HOST, MCTP_BTU,
865 &kcs, lpc_mem);
866 assert(!rc);
Andrew Jeffery3a540662020-05-26 19:55:30 +0930867
868 /*
869 * Now that the host has initialised the control area, break
870 * something before polling the BMC
871 */
872 hdr = lpc_mem;
873 hdr->layout.rx_size = 0;
874
875 mctp_astlpc_poll(bmc.astlpc);
876
877 /* Make sure the BMC has not set the channel to active */
878 assert(!(kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_CHANNEL_ACTIVE));
879
880 endpoint_destroy(&host);
881 endpoint_destroy(&bmc);
882 free(lpc_mem);
883}
884
885static void astlpc_test_buffers_bad_bmc_proposal(void)
886{
887 struct astlpc_endpoint bmc, host;
888 struct mctp_lpcmap_hdr *hdr;
889 uint8_t kcs[2] = { 0 };
890 void *lpc_mem;
891 int rc;
892
893 /* Test harness initialisation */
894 lpc_mem = calloc(1, 1 * 1024 * 1024);
895 assert(lpc_mem);
896
897 /* BMC initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930898 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
899 &kcs, lpc_mem);
900 assert(!rc);
Andrew Jeffery3a540662020-05-26 19:55:30 +0930901
902 /*
903 * Now that the BMC has initialised the control area, break something
904 * before initialising the host
905 */
906 hdr = lpc_mem;
907 hdr->layout.rx_size = 0;
908
909 /* Host initialisation: Fails due to bad layout */
Andrew Jefferya9368982020-06-09 13:07:39 +0930910 rc = endpoint_init(&host, 9, MCTP_BINDING_ASTLPC_MODE_HOST, MCTP_BTU,
911 &kcs, lpc_mem);
Andrew Jeffery3a540662020-05-26 19:55:30 +0930912 assert(rc < 0);
913
914 endpoint_destroy(&host);
915 endpoint_destroy(&bmc);
916 free(lpc_mem);
917}
918
919static void astlpc_test_buffers_bad_bmc_negotiation(void)
920{
921 struct astlpc_endpoint bmc, host;
922 struct mctp_lpcmap_hdr *hdr;
923 uint8_t kcs[2] = { 0 };
924 void *lpc_mem;
925 int rc;
926
927 /* Test harness initialisation */
928 lpc_mem = calloc(1, 1 * 1024 * 1024);
929 assert(lpc_mem);
930
931 /* BMC initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930932 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, MCTP_BTU,
933 &kcs, lpc_mem);
934 assert(!rc);
Andrew Jeffery3a540662020-05-26 19:55:30 +0930935
936 /* Host initialisation */
Andrew Jefferya9368982020-06-09 13:07:39 +0930937 rc = endpoint_init(&host, 9, MCTP_BINDING_ASTLPC_MODE_HOST, MCTP_BTU,
938 &kcs, lpc_mem);
939 assert(!rc);
Andrew Jeffery3a540662020-05-26 19:55:30 +0930940
941 mctp_astlpc_poll(bmc.astlpc);
942
943 /*
944 * Now that the BMC has initialised the control area, break something
945 * before polling the host
946 */
947 hdr = lpc_mem;
948 hdr->layout.rx_size = 0;
949
950 rc = mctp_astlpc_poll(host.astlpc);
951 assert(rc < 0);
952
953 endpoint_destroy(&host);
954 endpoint_destroy(&bmc);
955 free(lpc_mem);
956}
957
Andrew Jefferya9368982020-06-09 13:07:39 +0930958static void astlpc_test_buffers_bad_host_init(void)
959{
960 struct astlpc_endpoint host;
961 uint8_t kcs[2] = { 0 };
962 void *lpc_mem;
963 int rc;
964
965 /* Test harness initialisation */
966 lpc_mem = calloc(1, 1 * 1024 * 1024);
967 assert(lpc_mem);
968
969 host.mctp = mctp_init();
970 assert(host.mctp);
971 host.mmio.kcs = &kcs;
972 host.mmio.bmc = false;
973
974 /* Set the MTU to 0 to provoke a failure */
975 host.astlpc =
976 mctp_astlpc_init(MCTP_BINDING_ASTLPC_MODE_HOST, 0, lpc_mem,
977 &astlpc_direct_mmio_ops, &host.mmio);
978
979 rc = mctp_register_bus(host.mctp, &host.astlpc->binding, 8);
980 assert(rc < 0);
981
982 mctp_astlpc_destroy(host.astlpc);
983 mctp_destroy(host.mctp);
984 free(lpc_mem);
985}
986
987static void astlpc_test_negotiate_increased_mtu(void)
988{
989 struct astlpc_endpoint bmc, host;
990 uint8_t kcs[2] = { 0 };
991 void *lpc_mem;
992 int rc;
993
994 /* Test harness initialisation */
995 lpc_mem = calloc(1, 1 * 1024 * 1024);
996 assert(lpc_mem);
997
998 /* BMC initialisation */
999 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, 3 * MCTP_BTU,
1000 &kcs, lpc_mem);
1001 assert(!rc);
1002
1003 /* Host initialisation */
1004 rc = endpoint_init(&host, 9, MCTP_BINDING_ASTLPC_MODE_HOST,
1005 2 * MCTP_BTU, &kcs, lpc_mem);
1006 assert(!rc);
1007
1008 rc = mctp_astlpc_poll(bmc.astlpc);
1009 assert(rc == 0);
1010
1011 rc = mctp_astlpc_poll(host.astlpc);
1012 assert(rc == 0);
1013
1014 endpoint_destroy(&host);
1015 endpoint_destroy(&bmc);
1016 free(lpc_mem);
1017}
1018
1019static void astlpc_test_negotiate_mtu_low_high(void)
1020{
1021 struct astlpc_endpoint bmc, host;
1022 uint8_t kcs[2] = { 0 };
Andrew Jeffery88412be2021-03-09 22:05:22 +10301023 uint32_t bmtu, hmtu;
Andrew Jefferya9368982020-06-09 13:07:39 +09301024 void *lpc_mem;
1025 int rc;
1026
1027 /* Test harness initialisation */
1028 lpc_mem = calloc(1, 1 * 1024 * 1024);
1029 assert(lpc_mem);
1030
1031 /* BMC initialisation */
Andrew Jeffery88412be2021-03-09 22:05:22 +10301032 bmtu = 3 * MCTP_BTU;
1033 rc = endpoint_init(&bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, bmtu, &kcs,
1034 lpc_mem);
Andrew Jefferya9368982020-06-09 13:07:39 +09301035 assert(!rc);
1036
1037 /* Host initialisation with low MTU */
Andrew Jeffery88412be2021-03-09 22:05:22 +10301038 hmtu = 2 * MCTP_BTU;
1039 rc = endpoint_init(&host, 9, MCTP_BINDING_ASTLPC_MODE_HOST, hmtu, &kcs,
1040 lpc_mem);
Andrew Jefferya9368982020-06-09 13:07:39 +09301041 assert(!rc);
1042
1043 /* Process low MTU proposal */
1044 rc = mctp_astlpc_poll(bmc.astlpc);
1045 assert(rc == 0);
1046
1047 /* Accept low MTU proposal */
1048 rc = mctp_astlpc_poll(host.astlpc);
1049 assert(rc == 0);
1050
1051 assert(host.astlpc->layout.rx.size ==
Andrew Jeffery88412be2021-03-09 22:05:22 +10301052 astlpc_layout_ctx.proto->packet_size(MCTP_PACKET_SIZE(hmtu)));
Andrew Jefferya9368982020-06-09 13:07:39 +09301053
1054 /* Tear-down the host so we can bring up a new one */
1055 endpoint_destroy(&host);
1056
1057 /*
1058 * Bring up a new host endpoint with a higher MTU than we previously
1059 * negotiated
1060 */
Andrew Jeffery88412be2021-03-09 22:05:22 +10301061 hmtu = 3 * MCTP_BTU;
1062 rc = endpoint_init(&host, 9, MCTP_BINDING_ASTLPC_MODE_HOST, hmtu, &kcs,
1063 lpc_mem);
Andrew Jefferya9368982020-06-09 13:07:39 +09301064 assert(!rc);
1065
1066 /* Process high MTU proposal */
1067 rc = mctp_astlpc_poll(bmc.astlpc);
1068 assert(rc == 0);
1069
1070 /* Accept high MTU proposal */
1071 rc = mctp_astlpc_poll(host.astlpc);
1072 assert(rc == 0);
1073
1074 assert(host.astlpc->layout.rx.size ==
Andrew Jeffery88412be2021-03-09 22:05:22 +10301075 astlpc_layout_ctx.proto->packet_size(MCTP_PACKET_SIZE(bmtu)));
Andrew Jefferya9368982020-06-09 13:07:39 +09301076
1077 endpoint_destroy(&host);
1078 endpoint_destroy(&bmc);
1079 free(lpc_mem);
1080}
1081
Andrew Jefferyc2b833e2020-10-28 14:28:37 +10301082static void astlpc_test_send_large_packet(void)
1083{
1084 struct astlpc_endpoint *bmc, *host;
1085 struct astlpc_test ctx;
1086 uint8_t kcs[2] = { 0 };
1087 void *lpc_mem;
1088 int rc;
1089
1090 host = &ctx.host;
1091 bmc = &ctx.bmc;
1092
1093 /* Test harness initialisation */
1094 lpc_mem = calloc(1, 1 * 1024 * 1024);
1095 assert(lpc_mem);
1096
1097 /* BMC initialisation */
1098 rc = endpoint_init(bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, 8192, &kcs,
1099 lpc_mem);
1100 assert(!rc);
1101
1102 /* Host initialisation */
1103 rc = endpoint_init(host, 9, MCTP_BINDING_ASTLPC_MODE_HOST, 8192, &kcs,
1104 lpc_mem);
1105 assert(!rc);
1106
1107 ctx.count = 0;
1108 mctp_set_rx_all(bmc->mctp, rx_message, &ctx);
1109
1110 rc = mctp_astlpc_poll(bmc->astlpc);
1111 assert(rc == 0);
1112
1113 rc = mctp_astlpc_poll(host->astlpc);
1114 assert(rc == 0);
1115
1116 ctx.msg = malloc(2 * MCTP_BODY_SIZE(8192));
1117 assert(ctx.msg);
1118
1119 memset(ctx.msg, 0x5a, 2 * MCTP_BODY_SIZE(8192));
1120
1121 rc = mctp_message_tx(host->mctp, 8, ctx.msg, 2 * MCTP_BODY_SIZE(8192));
1122 assert(rc == 0);
1123 rc = mctp_astlpc_poll(bmc->astlpc);
1124 assert(rc == 0);
1125 rc = mctp_astlpc_poll(host->astlpc);
1126 assert(rc == 0);
1127 rc = mctp_astlpc_poll(bmc->astlpc);
1128 assert(rc == 0);
1129 rc = mctp_astlpc_poll(host->astlpc);
1130 assert(rc == 0);
1131
1132 assert(ctx.count == 1);
1133
1134 free(ctx.msg);
1135 endpoint_destroy(host);
1136 endpoint_destroy(bmc);
1137 free(lpc_mem);
1138}
1139
Andrew Jeffery3f4bca92021-01-28 14:19:19 +10301140static void astlpc_test_tx_before_channel_init(void)
1141{
1142 struct astlpc_endpoint *bmc;
1143 struct astlpc_test ctx;
1144 uint8_t kcs[2] = { 0 };
1145 uint8_t msg[MCTP_BTU];
1146 void *lpc_mem;
1147 int rc;
1148
1149 bmc = &ctx.bmc;
1150
1151 /* Test harness initialisation */
1152 lpc_mem = calloc(1, 1 * 1024 * 1024);
1153 assert(lpc_mem);
1154
1155 /* BMC initialisation */
1156 rc = endpoint_init(bmc, 8, MCTP_BINDING_ASTLPC_MODE_BMC, 0, &kcs,
1157 lpc_mem);
1158 assert(!rc);
1159
1160 memset(msg, '\0', sizeof(msg));
1161
1162 /*
1163 * There was once a bug where the calculated MTU was 0 and the
1164 * packetisation loop in mctp_message_tx_on_bus() allocated all the
1165 * memory. Catch the bug and avoid OOMing the test machine by
1166 * terminating after a period long enough to packetise the message.
1167 */
1168 alarm(1);
1169 mctp_message_tx(bmc->mctp, 9, msg, sizeof(msg));
1170 alarm(0);
1171
1172 endpoint_destroy(bmc);
1173 free(lpc_mem);
1174}
1175
Andrew Jefferyeba19a32021-03-09 23:09:40 +10301176static void astlpc_test_corrupt_host_tx(void)
1177{
1178 struct astlpc_test ctx = { 0 };
1179 struct mctp_lpcmap_hdr *hdr;
1180 uint8_t msg[MCTP_BTU];
1181 uint32_t offset;
1182 uint32_t code;
1183 uint8_t *tlr;
1184 int rc;
1185
1186 /* Test harness initialisation */
1187
1188 network_init(&ctx);
1189
1190 memset(&msg[0], 0xa5, MCTP_BTU);
1191
1192 ctx.msg = &msg[0];
1193 ctx.count = 0;
1194 mctp_set_rx_all(ctx.bmc.mctp, rx_message, &ctx);
1195
1196 /* Host sends the single-packet message */
1197 rc = mctp_message_tx(ctx.host.mctp, 8, msg, sizeof(msg));
1198 assert(rc == 0);
1199 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_IBF);
1200 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x01);
1201
1202 astlpc_assert_tx_packet(&ctx.host, &msg[0], MCTP_BTU);
1203
1204 /* Corrupt the CRC-32 in the message trailer */
1205 hdr = (struct mctp_lpcmap_hdr *)ctx.lpc_mem;
1206 offset = be32toh(hdr->layout.tx_offset);
1207 tlr = (uint8_t *)&ctx.lpc_mem[offset] + 4 + sizeof(msg);
1208 memcpy(&code, tlr, sizeof(code));
1209 code = ~code;
1210 memcpy(tlr, &code, sizeof(code));
1211
1212 /* BMC receives the single-packet message */
1213 mctp_astlpc_poll(ctx.bmc.astlpc);
1214 assert(ctx.count == 0);
1215
1216 /* BMC returns Tx area ownership to Host */
1217 assert(!(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_IBF));
1218 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x02);
1219 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_OBF);
1220
1221 /* Host dequeues ownership hand-over */
1222 rc = mctp_astlpc_poll(ctx.host.astlpc);
1223 assert(rc == 0);
1224
1225 network_destroy(&ctx);
1226}
1227
1228static void astlpc_test_corrupt_bmc_tx(void)
1229{
1230 struct astlpc_test ctx = { 0 };
1231 struct mctp_lpcmap_hdr *hdr;
1232 uint8_t msg[MCTP_BTU];
1233 uint32_t offset;
1234 uint32_t code;
1235 uint8_t *tlr;
1236 int rc;
1237
1238 /* Test harness initialisation */
1239
1240 network_init(&ctx);
1241
1242 memset(&msg[0], 0x5a, MCTP_BTU);
1243
1244 ctx.msg = &msg[0];
1245 ctx.count = 0;
1246 mctp_set_rx_all(ctx.host.mctp, rx_message, &ctx);
1247
1248 /* BMC sends the single-packet message */
1249 rc = mctp_message_tx(ctx.bmc.mctp, 9, msg, sizeof(msg));
1250 assert(rc == 0);
1251 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_OBF);
1252 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x01);
1253
1254 /* Check that the BMC sent a fully-formed packet */
1255 astlpc_assert_tx_packet(&ctx.bmc, &msg[0], MCTP_BTU);
1256
1257 /* Corrupt the CRC-32 in the message trailer */
1258 hdr = (struct mctp_lpcmap_hdr *)ctx.lpc_mem;
1259 offset = be32toh(hdr->layout.rx_offset);
1260 tlr = (uint8_t *)&ctx.lpc_mem[offset] + 4 + sizeof(msg);
1261 memcpy(&code, tlr, sizeof(code));
1262 code = ~code;
1263 memcpy(tlr, &code, sizeof(code));
1264
1265 /* Host drops the single-packet message */
1266 mctp_astlpc_poll(ctx.host.astlpc);
1267 assert(ctx.count == 0);
1268
1269 /* Host returns Rx area ownership to BMC */
1270 assert(!(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_OBF));
1271 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_DATA] == 0x02);
1272 assert(ctx.kcs[MCTP_ASTLPC_KCS_REG_STATUS] & KCS_STATUS_IBF);
1273
1274 /* BMC dequeues ownership hand-over */
1275 rc = mctp_astlpc_poll(ctx.bmc.astlpc);
1276 assert(rc == 0);
1277
1278 network_destroy(&ctx);
1279}
1280
Andrew Jeffery91f09ed2020-05-22 20:52:26 +09301281/* clang-format off */
1282#define TEST_CASE(test) { #test, test }
1283static const struct {
1284 const char *name;
1285 void (*test)(void);
1286} astlpc_tests[] = {
1287 TEST_CASE(astlpc_test_simple_init),
Andrew Jeffery4e8264b2020-05-23 20:34:33 +09301288 TEST_CASE(astlpc_test_bad_version),
1289 TEST_CASE(astlpc_test_incompatible_versions),
1290 TEST_CASE(astlpc_test_choose_bmc_ver_cur),
1291 TEST_CASE(astlpc_test_choose_host_ver_cur),
1292 TEST_CASE(astlpc_test_version_host_fails_negotiation),
1293 TEST_CASE(astlpc_test_version_bmc_fails_negotiation),
Andrew Jefferyf1cdb162020-05-23 21:25:21 +09301294 TEST_CASE(astlpc_test_host_before_bmc),
Andrew Jeffery91f09ed2020-05-22 20:52:26 +09301295 TEST_CASE(astlpc_test_simple_message_bmc_to_host),
Andrew Jefferyec9a0062020-05-22 21:21:55 +09301296 TEST_CASE(astlpc_test_simple_message_host_to_bmc),
Andrew Jeffery91f09ed2020-05-22 20:52:26 +09301297 TEST_CASE(astlpc_test_packetised_message_bmc_to_host),
Andrew Jefferyd0f5da02020-05-28 09:12:55 +09301298 TEST_CASE(astlpc_test_simple_indirect_message_bmc_to_host),
1299 TEST_CASE(astlpc_test_host_tx_bmc_gone),
Andrew Jefferyf3d94dc2020-05-28 10:50:18 +09301300 TEST_CASE(astlpc_test_poll_not_ready),
Andrew Jeffery67655e82020-05-28 10:51:27 +09301301 TEST_CASE(astlpc_test_undefined_command),
Andrew Jeffery3a540662020-05-26 19:55:30 +09301302 TEST_CASE(astlpc_test_buffers_rx_offset_overflow),
1303 TEST_CASE(astlpc_test_buffers_tx_offset_overflow),
1304 TEST_CASE(astlpc_test_buffers_rx_size_overflow),
1305 TEST_CASE(astlpc_test_buffers_tx_size_overflow),
1306 TEST_CASE(astlpc_test_buffers_rx_window_violation),
1307 TEST_CASE(astlpc_test_buffers_tx_window_violation),
1308 TEST_CASE(astlpc_test_buffers_rx_size_fails_btu),
1309 TEST_CASE(astlpc_test_buffers_tx_size_fails_btu),
1310 TEST_CASE(astlpc_test_buffers_overlap_rx_low),
1311 TEST_CASE(astlpc_test_buffers_overlap_tx_low),
1312 TEST_CASE(astlpc_test_buffers_bad_host_proposal),
1313 TEST_CASE(astlpc_test_buffers_bad_bmc_proposal),
1314 TEST_CASE(astlpc_test_buffers_bad_bmc_negotiation),
1315 TEST_CASE(astlpc_test_buffers_overlap_exact),
1316 TEST_CASE(astlpc_test_buffers_overlap_control),
Andrew Jefferya9368982020-06-09 13:07:39 +09301317 TEST_CASE(astlpc_test_buffers_bad_host_init),
1318 TEST_CASE(astlpc_test_negotiate_increased_mtu),
1319 TEST_CASE(astlpc_test_negotiate_mtu_low_high),
Andrew Jefferyc2b833e2020-10-28 14:28:37 +10301320 TEST_CASE(astlpc_test_send_large_packet),
Andrew Jeffery3f4bca92021-01-28 14:19:19 +10301321 TEST_CASE(astlpc_test_tx_before_channel_init),
Andrew Jefferyeba19a32021-03-09 23:09:40 +10301322 TEST_CASE(astlpc_test_corrupt_host_tx),
1323 TEST_CASE(astlpc_test_corrupt_bmc_tx),
Andrew Jeffery91f09ed2020-05-22 20:52:26 +09301324};
1325/* clang-format on */
1326
1327#ifndef BUILD_ASSERT
1328#define BUILD_ASSERT(x) \
1329 do { \
1330 (void)sizeof(char[0 - (!(x))]); \
1331 } while (0)
1332#endif
1333
Andrew Jefferye756de82020-05-22 12:30:58 +09301334int main(void)
1335{
Andrew Jeffery91f09ed2020-05-22 20:52:26 +09301336 size_t i;
1337
Andrew Jefferye756de82020-05-22 12:30:58 +09301338 mctp_set_log_stdio(MCTP_LOG_DEBUG);
1339
Andrew Jeffery91f09ed2020-05-22 20:52:26 +09301340 BUILD_ASSERT(ARRAY_SIZE(astlpc_tests) < SIZE_MAX);
1341 for (i = 0; i < ARRAY_SIZE(astlpc_tests); i++) {
1342 mctp_prlog(MCTP_LOG_DEBUG, "begin: %s", astlpc_tests[i].name);
1343 astlpc_tests[i].test();
1344 mctp_prlog(MCTP_LOG_DEBUG, "end: %s\n", astlpc_tests[i].name);
1345 }
Andrew Jeffery11b7e922020-03-10 23:37:09 +10301346
Andrew Jeffery0247c732020-02-06 11:48:52 +10301347 return 0;
1348}