tests: rtio: Add testcase to demonstrate multishot aborted on errors

By forcing IODEV test to throw errors and verifying no more CQE's are
coming through after the forced error.

Signed-off-by: Luis Ubieda <[email protected]>

Author: ubieda

tests/subsys/rtio/rtio_api/src/rtio_iodev_test.h

@@ -28,6 +28,9 @@ struct rtio_iodev_test_data {
 
 	/* Lock around kicking off next timer */
 	struct k_spinlock lock;
+
+	/* Mocked result to receive by the IODEV */
+	int result;
 };
 
 static void rtio_iodev_test_next(struct rtio_iodev_test_data *data, bool completion)
@@ -81,7 +84,7 @@ static void rtio_iodev_await_signaled(struct rtio_iodev_sqe *iodev_sqe, void *us
 {
 	struct rtio_iodev_test_data *data = userdata;
 
-	rtio_iodev_test_complete(data, 0);
+	rtio_iodev_test_complete(data, data->result);
 }
 
 static void rtio_iodev_timer_fn(struct k_timer *tm)
@@ -94,7 +97,7 @@ static void rtio_iodev_timer_fn(struct k_timer *tm)
 
 	switch (iodev_sqe->sqe.op) {
 	case RTIO_OP_NOP:
-		rtio_iodev_test_complete(data, 0);
+		rtio_iodev_test_complete(data, data->result);
 		break;
 	case RTIO_OP_RX:
 		rc = rtio_sqe_rx_buf(iodev_sqe, 16, 16, &buf, &buf_len);
@@ -104,7 +107,7 @@ static void rtio_iodev_timer_fn(struct k_timer *tm)
 		}
 		/* For reads the test device copies from the given userdata */
 		memcpy(buf, ((uint8_t *)iodev_sqe->sqe.userdata), 16);
-		rtio_iodev_test_complete(data, 0);
+		rtio_iodev_test_complete(data, data->result);
 		break;
 	case RTIO_OP_AWAIT:
 		rtio_iodev_sqe_await_signal(iodev_sqe, rtio_iodev_await_signaled, data);
@@ -139,6 +142,14 @@ void rtio_iodev_test_init(struct rtio_iodev *test)
 	data->txn_head = NULL;
 	data->txn_curr = NULL;
 	k_timer_init(&data->timer, rtio_iodev_timer_fn, NULL);
+	data->result = 0;
+}
+
+void rtio_iodev_test_set_result(struct rtio_iodev *test, int result)
+{
+	struct rtio_iodev_test_data *data = test->data;
+
+	data->result = result;
 }
 
 #define RTIO_IODEV_TEST_DEFINE(name)                                                               \

tests/subsys/rtio/rtio_api/src/test_rtio_api.c

@@ -532,6 +532,46 @@ ZTEST_USER(rtio_api, test_rtio_multishot)
 	}
 }
 
+ZTEST(rtio_api, test_rtio_multishot_are_not_resubmitted_when_failed)
+{
+	int res;
+	struct rtio_sqe sqe;
+	struct rtio_cqe cqe;
+	struct rtio_sqe *handle;
+	struct rtio *r = &r_simple;
+	uint8_t *buffer = NULL;
+	uint32_t buffer_len = 0;
+
+	for (int i = 0 ; i < MEM_BLK_SIZE; i++) {
+		mempool_data[i] = i;
+	}
+
+	rtio_sqe_prep_read_multishot(&sqe, (struct rtio_iodev *)&iodev_test_simple, 0,
+				     mempool_data);
+	res = rtio_sqe_copy_in_get_handles(r, &sqe, &handle, 1);
+	zassert_ok(res);
+
+	rtio_iodev_test_set_result(&iodev_test_simple, -EIO);
+
+	rtio_submit(r, 1);
+
+	/** The multi-shot SQE should fail, transmit the result and stop resubmitting. */
+	zassert_equal(1, rtio_cqe_copy_out(r, &cqe, 1, K_MSEC(100)));
+	zassert_equal(cqe.result, -EIO, "Result should be %d but got %d", -EIO, cqe.result);
+
+	/* No more CQE's coming as it should be aborted */
+	zassert_equal(0, rtio_cqe_copy_out(r, &cqe, 1, K_MSEC(100)),
+		      "Should not get more CQEs after the error CQE");
+
+	rtio_sqe_drop_all(r);
+
+	/* Flush any pending CQEs */
+	while (rtio_cqe_copy_out(r, &cqe, 1, K_MSEC(1000)) != 0) {
+		rtio_cqe_get_mempool_buffer(r, &cqe, &buffer, &buffer_len);
+		rtio_release_buffer(r, buffer, buffer_len);
+	}
+}
+
 RTIO_DEFINE(r_transaction, SQE_POOL_SIZE, CQE_POOL_SIZE);
 
 RTIO_IODEV_TEST_DEFINE(iodev_test_transaction0);