From fa83c7d4a71e6a6f3e50f2ef132b2a7959b6296b Mon Sep 17 00:00:00 2001
From: Marc Schink <dev@zapb.de>
Date: Sat, 12 Jun 2021 13:31:17 +0200
Subject: WIP: Add initial FINE support

Signed-off-by: Marc Schink <dev@zapb.de>
---
 libjaylink/Makefile.am  |   1 +
 libjaylink/fine.c       | 121 ++++++++++++++++++++++++++++++++++++++++++++++++
 libjaylink/libjaylink.h |   6 +++
 3 files changed, 128 insertions(+)
 create mode 100644 libjaylink/fine.c

diff --git a/libjaylink/Makefile.am b/libjaylink/Makefile.am
index 8e10212..818eee3 100644
--- a/libjaylink/Makefile.am
+++ b/libjaylink/Makefile.am
@@ -36,6 +36,7 @@ libjaylink_la_SOURCES = \
 	emucom.c \
 	error.c \
 	fileio.c \
+	fine.c \
 	jtag.c \
 	list.c \
 	log.c \
diff --git a/libjaylink/fine.c b/libjaylink/fine.c
new file mode 100644
index 0000000..a745cce
--- /dev/null
+++ b/libjaylink/fine.c
@@ -0,0 +1,121 @@
+/*
+ * This file is part of the libjaylink project.
+ *
+ * Copyright (C) 2021 Marc Schink <dev@zapb.de>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#include "libjaylink.h"
+#include "libjaylink-internal.h"
+
+/**
+ * @file
+ *
+ * Renesas’ single-wire debug interface (FINE) functions.
+ */
+
+/** @cond PRIVATE */
+#define CMD_FINE_IO 0xe0
+
+/**
+ * Perform a FINE I/O operation.
+ *
+ * @note This function must only be used if the #JAYLINK_TIF_FINE interface is
+ *       available and selected.
+ *
+ * TODO: Parameter documentation
+ *
+ * @retval JAYLINK_OK Success.
+ * @retval JAYLINK_ERR_ARG Invalid arguments.
+ * @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
+ * @retval JAYLINK_ERR_IO Input/output error.
+ * @retval JAYLINK_ERR_DEV_NO_MEMORY Not enough memory on the device to perform
+ *                                   the operation.
+ * @retval JAYLINK_ERR_DEV Unspecified device error.
+ * @retval JAYLINK_ERR Other error conditions.
+ *
+ * @see jaylink_select_interface()
+ * @see jaylink_set_speed()
+ *
+ * @since 0.2.0
+ */
+JAYLINK_API int jaylink_fine_io(struct jaylink_device_handle *devh,
+		const uint8_t *out, uint8_t *in, uint32_t out_length,
+		uint32_t in_length, uint32_t other_param)
+{
+	int ret;
+	struct jaylink_context *ctx;
+	uint8_t buf[13];
+
+	if (!devh || !out || !in)
+		return JAYLINK_ERR_ARG;
+
+	ctx = devh->dev->ctx;
+
+	ret = transport_start_write_read(devh, 13 + out_length, 4 + in_length,
+		true);
+
+	if (ret != JAYLINK_OK) {
+		log_err(ctx, "transport_start_write_read() failed: %s",
+			jaylink_strerror(ret));
+		return ret;
+	}
+
+	buf[0] = CMD_FINE_IO;
+	buffer_set_u32(buf, out_length, 1);
+	buffer_set_u32(buf, in_length, 5);
+	buffer_set_u32(buf, other_param, 9);
+
+	ret = transport_write(devh, buf, 13);
+
+	if (ret != JAYLINK_OK) {
+		log_err(ctx, "transport_write() failed: %s",
+			jaylink_strerror(ret));
+		return ret;
+	}
+
+	ret = transport_write(devh, out, out_length);
+
+	if (ret != JAYLINK_OK) {
+		log_err(ctx, "transport_write() failed: %s",
+			jaylink_strerror(ret));
+		return ret;
+	}
+
+	ret = transport_read(devh, in, in_length);
+
+	if (ret != JAYLINK_OK) {
+		log_err(ctx, "transport_read() failed: %s",
+			jaylink_strerror(ret));
+		return ret;
+	}
+
+	ret = transport_read(devh, buf, 4);
+	uint32_t status = buffer_get_u32(buf, 0);
+
+	if (ret != JAYLINK_OK) {
+		log_err(ctx, "transport_read() failed: %s",
+			jaylink_strerror(ret));
+		return ret;
+	}
+
+	/* TODO: Handle status. */
+	(void)status;
+
+	return JAYLINK_OK;
+}
diff --git a/libjaylink/libjaylink.h b/libjaylink/libjaylink.h
index d89913c..d86ee84 100644
--- a/libjaylink/libjaylink.h
+++ b/libjaylink/libjaylink.h
@@ -570,6 +570,12 @@ JAYLINK_API int jaylink_file_get_size(struct jaylink_device_handle *devh,
 JAYLINK_API int jaylink_file_delete(struct jaylink_device_handle *devh,
 		const char *filename);
 
+/*--- fine.c ----------------------------------------------------------------*/
+
+JAYLINK_API int jaylink_fine_io(struct jaylink_device_handle *devh,
+		const uint8_t *out, uint8_t *in, uint32_t out_length,
+		uint32_t in_length, uint32_t other_param);
+
 /*--- jtag.c ----------------------------------------------------------------*/
 
 JAYLINK_API int jaylink_jtag_io(struct jaylink_device_handle *devh,
-- 
cgit v1.1