jlink_spi: add cs=tms option to jlink_spi programmer

Currently, the code assumes the nCS pin of spi nor flash is connected to
either nRESET(pin 15) or nTRST(pin 3). But it is incompatible with the
pinout from official JFlash SPI, whereas the nCS pin is wired to TMS(pin
7).

This commit adds cs=tms option to share the same pinout as JFlash SPI.
It works by toggling TMS in assert_cs and deassert_cs, and sets TMS to
zero in jlink_spi_send_command. The default option is set to cs=reset
for backward compatibility.

Tested on macOS 13.3.1 with JLink and Winbond W25Q128

Change-Id: I0cb467fcc2c403a25f260462de0cd020e7022bb1
Signed-off-by: Jiajie Chen <c@jia.je>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/75011
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
Reviewed-by: Alexander Goncharov <chat@joursoir.net>

2 files changed, 43 insertions, 15 deletions

diff --git a/doc/classic_cli_manpage.rst b/doc/classic_cli_manpage.rst
index 45ef4aa9..a8ac6dab 100644
--- a/doc/classic_cli_manpage.rst
+++ b/doc/classic_cli_manpage.rst
@@ -1066,7 +1066,7 @@ programmer which can be selected with the::
 
         flashrom -p jlink_spi:cs=pin
 
-syntax where ``pin`` can be either ``TRST`` or ``RESET``. The default pin for chip select is ``RESET``.
+syntax where ``pin`` can be either ``TRST``, ``RESET`` or ``TMS``. The default pin for chip select is ``RESET``.
 Note that, when using ``RESET``, it is normal that the indicator LED blinks orange or red.
 
 Additionally, the ``Tref`` pin of the programmer must be attached to the logic level of the flash chip.
@@ -1079,7 +1079,7 @@ Pinout for devices with 20-pin JTAG connector::
           |  1  2 |     1: VTref     2:
           |  3  4 |     3: TRST      4: GND
           |  5  6 |     5: TDI       6: GND
-        +-+  7  8 |     7:           8: GND
+        +-+  7  8 |     7: TMS       8: GND
         |    9 10 |     9: TCK      10: GND
         |   11 12 |    11:          12: GND
         +-+ 13 14 |    13: TDO      14:
diff --git a/jlink_spi.c b/jlink_spi.c
index af61fb59..447629cc 100644
--- a/jlink_spi.c
+++ b/jlink_spi.c
@@ -51,10 +51,16 @@
 /* Minimum target voltage required for operation in mV. */
 #define MIN_TARGET_VOLTAGE	1200
 
+enum cs_wiring {
+	CS_RESET, /* nCS is wired to nRESET(pin 15) */
+	CS_TRST, /* nCS is wired to nTRST(pin 3) */
+	CS_TMS, /* nCS is wired to TMS/nCS(pin 7) */
+};
+
 struct jlink_spi_data {
 	struct jaylink_context *ctx;
 	struct jaylink_device_handle *devh;
-	bool reset_cs;
+	enum cs_wiring cs;
 	bool enable_target_power;
 };
 
@@ -62,20 +68,27 @@ static bool assert_cs(struct jlink_spi_data *jlink_data)
 {
 	int ret;
 
-	if (jlink_data->reset_cs) {
+	if (jlink_data->cs == CS_RESET) {
 		ret = jaylink_clear_reset(jlink_data->devh);
 
 		if (ret != JAYLINK_OK) {
 			msg_perr("jaylink_clear_reset() failed: %s.\n", jaylink_strerror(ret));
 			return false;
 		}
-	} else {
+	} else if (jlink_data->cs == CS_TRST) {
 		ret = jaylink_jtag_clear_trst(jlink_data->devh);
 
 		if (ret != JAYLINK_OK) {
 			msg_perr("jaylink_jtag_clear_trst() failed: %s.\n", jaylink_strerror(ret));
 			return false;
 		}
+	} else {
+		ret = jaylink_jtag_clear_tms(jlink_data->devh);
+
+		if (ret != JAYLINK_OK) {
+			msg_perr("jaylink_jtag_clear_tms() failed: %s.\n", jaylink_strerror(ret));
+			return false;
+		}
 	}
 
 	return true;
@@ -85,20 +98,27 @@ static bool deassert_cs(struct jlink_spi_data *jlink_data)
 {
 	int ret;
 
-	if (jlink_data->reset_cs) {
+	if (jlink_data->cs == CS_RESET) {
 		ret = jaylink_set_reset(jlink_data->devh);
 
 		if (ret != JAYLINK_OK) {
 			msg_perr("jaylink_set_reset() failed: %s.\n", jaylink_strerror(ret));
 			return false;
 		}
-	} else {
+	} else if (jlink_data->cs == CS_TRST) {
 		ret = jaylink_jtag_set_trst(jlink_data->devh);
 
 		if (ret != JAYLINK_OK) {
 			msg_perr("jaylink_jtag_set_trst() failed: %s.\n", jaylink_strerror(ret));
 			return false;
 		}
+	} else {
+		ret = jaylink_jtag_set_tms(jlink_data->devh);
+
+		if (ret != JAYLINK_OK) {
+			msg_perr("jaylink_jtag_set_tms() failed: %s.\n", jaylink_strerror(ret));
+			return false;
+		}
 	}
 
 	return true;
@@ -109,6 +129,7 @@ static int jlink_spi_send_command(const struct flashctx *flash, unsigned int wri
 {
 	uint32_t length;
 	uint8_t *buffer;
+	static const uint8_t zeros[JTAG_MAX_TRANSFER_SIZE] = {0};
 	struct jlink_spi_data *jlink_data = flash->mst->spi.data;
 
 	length = writecnt + readcnt;
@@ -133,10 +154,13 @@ static int jlink_spi_send_command(const struct flashctx *flash, unsigned int wri
 		return SPI_PROGRAMMER_ERROR;
 	}
 
+	/* If CS is wired to TMS, TMS should remain zero. */
+	const uint8_t *tms_buffer = jlink_data->cs == CS_TMS ? zeros : buffer;
+
 	int ret;
 
 	ret = jaylink_jtag_io(jlink_data->devh,
-				buffer, buffer, buffer, length * 8, JAYLINK_JTAG_VERSION_2);
+				tms_buffer, buffer, buffer, length * 8, JAYLINK_JTAG_VERSION_2);
 
 	if (ret != JAYLINK_OK) {
 		msg_perr("jaylink_jtag_io() failed: %s.\n", jaylink_strerror(ret));
@@ -196,7 +220,7 @@ static int jlink_spi_init(const struct programmer_cfg *cfg)
 	unsigned long speed = 0;
 	struct jaylink_context *jaylink_ctx = NULL;
 	struct jaylink_device_handle *jaylink_devh = NULL;
-	bool reset_cs;
+	enum cs_wiring cs;
 	struct jlink_spi_data *jlink_data = NULL;
 	bool enable_target_power;
 
@@ -255,14 +279,16 @@ static int jlink_spi_init(const struct programmer_cfg *cfg)
 
 	free(arg);
 
-	reset_cs = true;
+	cs = CS_RESET;
 	arg = extract_programmer_param_str(cfg, "cs");
 
 	if (arg) {
 		if (!strcasecmp(arg, "reset")) {
-			reset_cs = true;
+			cs = CS_RESET;
 		} else if (!strcasecmp(arg, "trst")) {
-			reset_cs = false;
+			cs = CS_TRST;
+		} else if (!strcasecmp(arg, "tms")) {
+			cs = CS_TMS;
 		} else {
 			msg_perr("Invalid chip select pin specified: '%s'.\n", arg);
 			free(arg);
@@ -272,10 +298,12 @@ static int jlink_spi_init(const struct programmer_cfg *cfg)
 
 	free(arg);
 
-	if (reset_cs)
+	if (cs == CS_RESET)
 		msg_pdbg("Using RESET as chip select signal.\n");
-	else
+	else if (cs == CS_TRST)
 		msg_pdbg("Using TRST as chip select signal.\n");
+	else
+		msg_pdbg("Using TMS/CS as chip select signal.\n");
 
 	enable_target_power = false;
 	arg = extract_programmer_param_str(cfg, "power");
@@ -506,7 +534,7 @@ static int jlink_spi_init(const struct programmer_cfg *cfg)
 	/* jaylink_ctx, jaylink_devh are allocated by jaylink_init and jaylink_open */
 	jlink_data->ctx = jaylink_ctx;
 	jlink_data->devh = jaylink_devh;
-	jlink_data->reset_cs = reset_cs;
+	jlink_data->cs = cs;
 	jlink_data->enable_target_power = enable_target_power;
 
 	/* Ensure that the CS signal is not active initially. */