This is an automated email from Gerrit.

"Conor Paxton <conor.pax...@microchip.com>" just uploaded a new patch set to 
Gerrit, which you can find at https://review.openocd.org/c/openocd/+/8563

-- gerrit

commit 7a7d87e637a55701ddd6e888f824da2ee263cba5
Author: Conor Paxton <conor.pax...@microchip.com>
Date:   Wed May 22 00:13:00 2024 +0100

    jtag: drivers: add microchip flashpro5 support
    
    This patch adds support for Microchip's FlashPro5 debug probe.
    
    Change-Id: I2060b5e9e691e5681beb3167f262f260e8d9e6cb
    Signed-off-by: Tommy Murphy <tommy_mur...@hotmail.com>
    Signed-off-by: Anton Krug <anton.k...@gmail.com>
    Signed-off-by: Daire McNamara <daire.mcnam...@microchip.com>
    Signed-off-by: Matteo Bonicolini <matteo.bonicol...@microchip.com>
    Signed-off-by: Conor Paxton <conor.pax...@microchip.com>

diff --git a/configure.ac b/configure.ac
index cbd2ecedb2..b6659bc27e 100644
--- a/configure.ac
+++ b/configure.ac
@@ -146,7 +146,8 @@ m4_define([HIDAPI_USB1_ADAPTERS],
 
 m4_define([LIBFTDI_ADAPTERS],
        [[[usb_blaster], [Altera USB-Blaster Compatible], [USB_BLASTER]],
-       [[presto], [ASIX Presto Adapter], [PRESTO]]])
+       [[presto], [ASIX Presto Adapter], [PRESTO]],
+       [[microchip_fp5_ftdi], [Microchip Flashpro 5 Debugger], 
[MICROCHIP_FP5_FTDI]]])
 
 m4_define([LIBFTDI_USB1_ADAPTERS],
        [[[openjtag], [OpenJTAG Adapter], [OPENJTAG]]])
diff --git a/src/jtag/drivers/Makefile.am b/src/jtag/drivers/Makefile.am
index 3ef4d4f6c3..4712557326 100644
--- a/src/jtag/drivers/Makefile.am
+++ b/src/jtag/drivers/Makefile.am
@@ -210,6 +210,10 @@ endif
 if MICROCHIP_EFP6
 DRIVERFILES += %D%/mchp_efp6.c
 endif
+if MICROCHIP_FP5_FTDI
+DRIVERFILES += %D%/mchp_ftdi.c
+DRIVERFILES += %D%/mchp_fp5_ftdi.c
+endif
 
 DRIVERHEADERS = \
        %D%/bitbang.h \
diff --git a/src/jtag/drivers/mchp_fp5_ftdi.c b/src/jtag/drivers/mchp_fp5_ftdi.c
new file mode 100644
index 0000000000..37660bcb74
--- /dev/null
+++ b/src/jtag/drivers/mchp_fp5_ftdi.c
@@ -0,0 +1,911 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+/* project specific includes */
+#include <jtag/adapter.h>
+#include <jtag/interface.h>
+#include <transport/transport.h>
+#include <helper/time_support.h>
+#include <helper/log.h>
+#include <helper/nvp.h>
+
+#if IS_CYGWIN == 1
+#include <windows.h>
+#endif
+
+#include <assert.h>
+
+/* FTDI access library includes */
+#include "mpsse.h"
+
+#define JTAG_MODE (LSB_FIRST | POS_EDGE_IN | NEG_EDGE_OUT)
+#define JTAG_MODE_ALT (LSB_FIRST | NEG_EDGE_IN | NEG_EDGE_OUT)
+
+static char *ftdi_device_desc;
+static uint8_t ftdi_channel;
+static uint8_t ftdi_jtag_mode = JTAG_MODE;
+
+#define MAX_USB_IDS 8
+/* vid = pid = 0 marks the end of the list */
+static uint16_t ftdi_vid[MAX_USB_IDS + 1] = { 0 };
+static uint16_t ftdi_pid[MAX_USB_IDS + 1] = { 0 };
+
+static struct mpsse_ctx *mpsse_ctx;
+
+struct signal {
+       const char *name;
+       uint16_t data_mask;
+       uint16_t input_mask;
+       uint16_t oe_mask;
+       bool invert_data;
+       bool invert_input;
+       bool invert_oe;
+       struct signal *next;
+};
+
+static struct signal *signals;
+
+static int freq;
+
+static uint16_t output;
+static uint16_t direction;
+static uint16_t jtag_output_init;
+static uint16_t jtag_direction_init;
+
+static struct signal *find_signal_by_name(const char *name)
+{
+       for (struct signal *sig = signals; sig; sig = sig->next) {
+               if (strcmp(name, sig->name) == 0)
+                       return sig;
+       }
+       return NULL;
+}
+
+static struct signal *create_signal(const char *name)
+{
+       struct signal **psig = &signals;
+       while (*psig)
+               psig = &(*psig)->next;
+
+       *psig = calloc(1, sizeof(**psig));
+       if (!*psig)
+               return NULL;
+
+       (*psig)->name = strdup(name);
+       if (!(*psig)->name) {
+               free(*psig);
+               *psig = NULL;
+       }
+       return *psig;
+}
+
+static int mchp_ftdi_set_signal(const struct signal *s, char value)
+{
+       bool data;
+       bool oe;
+
+       if (s->data_mask == 0 && s->oe_mask == 0) {
+               LOG_ERROR("interface doesn't provide signal '%s'", s->name);
+               return ERROR_FAIL;
+       }
+       switch (value) {
+       case '0':
+               data = s->invert_data;
+               oe = !s->invert_oe;
+               break;
+       case '1':
+               if (s->data_mask == 0) {
+                       LOG_ERROR("interface can't drive '%s' high", s->name);
+                       return ERROR_FAIL;
+               }
+               data = !s->invert_data;
+               oe = !s->invert_oe;
+               break;
+       case 'z':
+       case 'Z':
+               if (s->oe_mask == 0) {
+                       LOG_ERROR("interface can't tri-state '%s'", s->name);
+                       return ERROR_FAIL;
+               }
+               data = s->invert_data;
+               oe = s->invert_oe;
+               break;
+       default:
+               LOG_ERROR("invalid signal level specifier \'%c\'(0x%02x)", 
value, value);
+               return ERROR_FAIL;
+       }
+
+       uint16_t old_output = output;
+       uint16_t old_direction = direction;
+
+       output = data ? output | s->data_mask : output & ~s->data_mask;
+       if (s->oe_mask == s->data_mask)
+               direction = oe ? direction | s->oe_mask : direction & 
~s->oe_mask;
+       else
+               output = oe ? output | s->oe_mask : output & ~s->oe_mask;
+
+       if ((output & 0xff) != (old_output & 0xff) || (direction & 0xff) != 
(old_direction & 0xff))
+               mpsse_set_data_bits_low_byte(mpsse_ctx, output & 0xff, 
direction & 0xff);
+       if ((output >> 8 != old_output >> 8) || (direction >> 8 != 
old_direction >> 8))
+               mpsse_set_data_bits_high_byte(mpsse_ctx, output >> 8, direction 
>> 8);
+
+       return ERROR_OK;
+}
+
+static int mchp_ftdi_get_signal(const struct signal *s, uint16_t *value_out)
+{
+       uint8_t data_low = 0;
+       uint8_t data_high = 0;
+
+       if (s->input_mask == 0) {
+               LOG_ERROR("interface doesn't provide signal '%s'", s->name);
+               return ERROR_FAIL;
+       }
+
+       if (s->input_mask & 0xff)
+               mpsse_read_data_bits_low_byte(mpsse_ctx, &data_low);
+       if (s->input_mask >> 8)
+               mpsse_read_data_bits_high_byte(mpsse_ctx, &data_high);
+
+       mpsse_flush(mpsse_ctx);
+
+       *value_out = (((uint16_t)data_high) << 8) | data_low;
+
+       if (s->invert_input)
+               *value_out = ~(*value_out);
+
+       *value_out &= s->input_mask;
+
+       return ERROR_OK;
+}
+
+/**
+ * Function move_to_state
+ * moves the TAP controller from the current state to a
+ * \a goal_state through a path given by tap_get_tms_path().  State transition
+ * logging is performed by delegation to clock_tms().
+ *
+ * @param goal_state is the destination state for the move.
+ */
+static void move_to_state(tap_state_t goal_state)
+{
+       tap_state_t start_state = tap_get_state();
+
+       /*      goal_state is 1/2 of a tuple/pair of states which allow 
convenient
+               lookup of the required TMS pattern to move to this state from 
the
+               start state.
+       */
+
+       /* do the 2 lookups */
+       uint8_t tms_bits  = tap_get_tms_path(start_state, goal_state);
+       int tms_count = tap_get_tms_path_len(start_state, goal_state);
+       assert(tms_count <= 8);
+
+       LOG_DEBUG_IO("start=%s goal=%s", tap_state_name(start_state), 
tap_state_name(goal_state));
+
+       /* Track state transitions step by step */
+       for (int i = 0; i < tms_count; i++)
+               tap_set_state(tap_state_transition(tap_get_state(), (tms_bits 
>> i) & 1));
+
+       mpsse_clock_tms_cs_out(mpsse_ctx,
+               &tms_bits,
+               0,
+               tms_count,
+               false,
+               ftdi_jtag_mode);
+}
+
+static int mchp_ftdi_speed(int speed)
+{
+       int retval;
+       retval = mpsse_set_frequency(mpsse_ctx, speed);
+
+       if (retval < 0) {
+               LOG_ERROR("couldn't set FTDI TCK speed");
+               return retval;
+       }
+
+       if (speed >= 10000000 && ftdi_jtag_mode != JTAG_MODE_ALT)
+               LOG_INFO("ftdi: if you experience problems at higher adapter 
clocks, try "
+                        "the command \"ftdi tdo_sample_edge falling\"");
+       return ERROR_OK;
+}
+
+static int mchp_ftdi_speed_div(int speed, int *khz)
+{
+       *khz = speed / 1000;
+       return ERROR_OK;
+}
+
+static int mchp_ftdi_khz(int khz, int *jtag_speed)
+{
+       if (khz == 0 && !mpsse_is_high_speed(mpsse_ctx)) {
+               LOG_DEBUG("RCLK not supported");
+               return ERROR_FAIL;
+       }
+
+       *jtag_speed = khz * 1000;
+       return ERROR_OK;
+}
+
+static void mchp_ftdi_end_state(tap_state_t state)
+{
+       if (tap_is_state_stable(state)) {
+               tap_set_end_state(state);
+       } else {
+               LOG_ERROR("BUG: %s is not a stable end state", 
tap_state_name(state));
+               exit(-1);
+       }
+}
+
+static void mchp_ftdi_execute_runtest(struct jtag_command *cmd)
+{
+       uint8_t zero = 0;
+
+       LOG_DEBUG_IO("runtest %u cycles, end in %s",
+               cmd->cmd.runtest->num_cycles,
+               tap_state_name(cmd->cmd.runtest->end_state));
+
+       if (tap_get_state() != TAP_IDLE)
+               move_to_state(TAP_IDLE);
+
+       /* TODO: Reuse mchp_ftdi_execute_stableclocks */
+       unsigned int i = cmd->cmd.runtest->num_cycles;
+       while (i > 0) {
+               /* there are no state transitions in this code, so omit state 
tracking */
+               unsigned int this_len = i > 7 ? 7 : i;
+               mpsse_clock_tms_cs_out(mpsse_ctx, &zero, 0, this_len, false, 
ftdi_jtag_mode);
+               i -= this_len;
+       }
+
+       mchp_ftdi_end_state(cmd->cmd.runtest->end_state);
+
+       if (tap_get_state() != tap_get_end_state())
+               move_to_state(tap_get_end_state());
+
+       LOG_DEBUG_IO("runtest: %u, end in %s",
+               cmd->cmd.runtest->num_cycles,
+               tap_state_name(tap_get_end_state()));
+}
+
+static void mchp_ftdi_execute_statemove(struct jtag_command *cmd)
+{
+       LOG_DEBUG_IO("statemove end in %s",
+               tap_state_name(cmd->cmd.statemove->end_state));
+
+       mchp_ftdi_end_state(cmd->cmd.statemove->end_state);
+
+       /* shortest-path move to desired end state */
+       if (tap_get_state() != tap_get_end_state() || tap_get_end_state() == 
TAP_RESET)
+               move_to_state(tap_get_end_state());
+}
+
+static void mchp_ftdi_execute_tms(struct jtag_command *cmd)
+{
+       LOG_DEBUG_IO("TMS: %u bits", cmd->cmd.tms->num_bits);
+
+       /* TODO: Missing tap state tracking, also missing from ft2232.c! */
+       mpsse_clock_tms_cs_out(mpsse_ctx,
+               cmd->cmd.tms->bits,
+               0,
+               cmd->cmd.tms->num_bits,
+               false,
+               ftdi_jtag_mode);
+}
+
+static void mchp_ftdi_execute_pathmove(struct jtag_command *cmd)
+{
+       tap_state_t *path = cmd->cmd.pathmove->path;
+       unsigned int num_states  = cmd->cmd.pathmove->num_states;
+
+       LOG_DEBUG_IO("pathmove: %u states, current: %s  end: %s", num_states,
+               tap_state_name(tap_get_state()),
+               tap_state_name(path[num_states - 1]));
+
+       int state_count = 0;
+       unsigned int bit_count = 0;
+       uint8_t tms_byte = 0;
+
+       LOG_DEBUG_IO("-");
+
+       /* this loop verifies that the path is legal and logs each state in the 
path */
+       while (num_states--) {
+               /* either TMS=0 or TMS=1 must work ... */
+               if (tap_state_transition(tap_get_state(), false)
+                   == path[state_count])
+                       buf_set_u32(&tms_byte, bit_count++, 1, 0x0);
+               else if (tap_state_transition(tap_get_state(), true)
+                        == path[state_count]) {
+                       buf_set_u32(&tms_byte, bit_count++, 1, 0x1);
+
+                       /* ... or else the caller goofed BADLY */
+               } else {
+                       LOG_ERROR("BUG: %s -> %s isn't a valid "
+                               "TAP state transition",
+                               tap_state_name(tap_get_state()),
+                               tap_state_name(path[state_count]));
+                       exit(-1);
+               }
+
+               tap_set_state(path[state_count]);
+               state_count++;
+
+               if (bit_count == 7 || num_states == 0) {
+                       mpsse_clock_tms_cs_out(mpsse_ctx,
+                                       &tms_byte,
+                                       0,
+                                       bit_count,
+                                       false,
+                                       ftdi_jtag_mode);
+                       bit_count = 0;
+               }
+       }
+       tap_set_end_state(tap_get_state());
+}
+
+static void mchp_ftdi_execute_scan(struct jtag_command *cmd)
+{
+       LOG_DEBUG_IO("%s type:%d", cmd->cmd.scan->ir_scan ? "IRSCAN" : "DRSCAN",
+               jtag_scan_type(cmd->cmd.scan));
+
+       /* Make sure there are no trailing fields with num_bits == 0, or the 
logic below will fail. */
+       while (cmd->cmd.scan->num_fields > 0
+                       && cmd->cmd.scan->fields[cmd->cmd.scan->num_fields - 
1].num_bits == 0) {
+               cmd->cmd.scan->num_fields--;
+               LOG_DEBUG_IO("discarding trailing empty field");
+       }
+
+       if (!cmd->cmd.scan->num_fields) {
+               LOG_DEBUG_IO("empty scan, doing nothing");
+               return;
+       }
+
+       if (cmd->cmd.scan->ir_scan) {
+               if (tap_get_state() != TAP_IRSHIFT)
+                       move_to_state(TAP_IRSHIFT);
+       } else {
+               if (tap_get_state() != TAP_DRSHIFT)
+                       move_to_state(TAP_DRSHIFT);
+       }
+
+       mchp_ftdi_end_state(cmd->cmd.scan->end_state);
+
+       struct scan_field *field = cmd->cmd.scan->fields;
+       unsigned int scan_size = 0;
+
+       for (unsigned int i = 0; i < cmd->cmd.scan->num_fields; i++, field++) {
+               scan_size += field->num_bits;
+               LOG_DEBUG_IO("%s%s field %u/%u %u bits",
+                       field->in_value ? "in" : "",
+                       field->out_value ? "out" : "",
+                       i,
+                       cmd->cmd.scan->num_fields,
+                       field->num_bits);
+
+               if (i == cmd->cmd.scan->num_fields - 1 && tap_get_state() != 
tap_get_end_state()) {
+                       /* Last field, and we're leaving IRSHIFT/DRSHIFT. Clock 
last bit during tap
+                        * movement. This last field can't have length zero, it 
was checked above. */
+                       mpsse_clock_data(mpsse_ctx,
+                               field->out_value,
+                               0,
+                               field->in_value,
+                               0,
+                               field->num_bits - 1,
+                               ftdi_jtag_mode);
+                       uint8_t last_bit = 0;
+                       if (field->out_value)
+                               bit_copy(&last_bit, 0, field->out_value, 
field->num_bits - 1, 1);
+
+                       /* If endstate is TAP_IDLE, clock out 1-1-0 (->EXIT1 
->UPDATE ->IDLE)
+                        * Otherwise, clock out 1-0 (->EXIT1 ->PAUSE)
+                        */
+                       uint8_t tms_bits = 0x03;
+                       mpsse_clock_tms_cs(mpsse_ctx,
+                                       &tms_bits,
+                                       0,
+                                       field->in_value,
+                                       field->num_bits - 1,
+                                       1,
+                                       last_bit,
+                                       ftdi_jtag_mode);
+                       tap_set_state(tap_state_transition(tap_get_state(), 1));
+                       if (tap_get_end_state() == TAP_IDLE) {
+                               mpsse_clock_tms_cs_out(mpsse_ctx,
+                                               &tms_bits,
+                                               1,
+                                               2,
+                                               last_bit,
+                                               ftdi_jtag_mode);
+                               
tap_set_state(tap_state_transition(tap_get_state(), 1));
+                               
tap_set_state(tap_state_transition(tap_get_state(), 0));
+                       } else {
+                               mpsse_clock_tms_cs_out(mpsse_ctx,
+                                               &tms_bits,
+                                               2,
+                                               1,
+                                               last_bit,
+                                               ftdi_jtag_mode);
+                               
tap_set_state(tap_state_transition(tap_get_state(), 0));
+                       }
+               } else {
+                       mpsse_clock_data(mpsse_ctx,
+                               field->out_value,
+                               0,
+                               field->in_value,
+                               0,
+                               field->num_bits,
+                               ftdi_jtag_mode);
+       }
+
+       if (tap_get_state() != tap_get_end_state())
+               move_to_state(tap_get_end_state());
+
+       LOG_DEBUG_IO("%s scan, %i bits, end in %s",
+               (cmd->cmd.scan->ir_scan) ? "IR" : "DR", scan_size,
+               tap_state_name(tap_get_end_state()));
+}
+
+static int mchp_ftdi_reset(int trst, int srst)
+{
+       struct signal *sig_ntrst = find_signal_by_name("nTRST");
+       struct signal *sig_nsrst = find_signal_by_name("nSRST");
+
+       LOG_DEBUG_IO("reset trst: %i srst %i", trst, srst);
+
+       if (trst == 1) {
+               if (sig_ntrst)
+                       mchp_ftdi_set_signal(sig_ntrst, '0');
+               else
+                       LOG_ERROR("Can't assert TRST: nTRST signal is not 
defined");
+       } else if (sig_ntrst && jtag_get_reset_config() & RESET_HAS_TRST &&
+                       trst == 0) {
+               if (jtag_get_reset_config() & RESET_TRST_OPEN_DRAIN)
+                       mchp_ftdi_set_signal(sig_ntrst, 'z');
+               else
+                       mchp_ftdi_set_signal(sig_ntrst, '1');
+       }
+
+       if (srst == 1) {
+               if (sig_nsrst)
+                       mchp_ftdi_set_signal(sig_nsrst, '0');
+               else
+                       LOG_ERROR("Can't assert SRST: nSRST signal is not 
defined");
+       } else if (sig_nsrst && jtag_get_reset_config() & RESET_HAS_SRST &&
+                       srst == 0) {
+               if (jtag_get_reset_config() & RESET_SRST_PUSH_PULL)
+                       mchp_ftdi_set_signal(sig_nsrst, '1');
+               else
+                       mchp_ftdi_set_signal(sig_nsrst, 'z');
+       }
+
+       return mpsse_flush(mpsse_ctx);
+}
+
+static void mchp_ftdi_execute_sleep(struct jtag_command *cmd)
+{
+       LOG_DEBUG_IO("sleep %" PRIu32, cmd->cmd.sleep->us);
+
+       mpsse_flush(mpsse_ctx);
+       jtag_sleep(cmd->cmd.sleep->us);
+       LOG_DEBUG_IO("sleep %" PRIu32 " usec while in %s",
+               cmd->cmd.sleep->us,
+               tap_state_name(tap_get_state()));
+}
+
+static void mchp_ftdi_execute_stableclocks(struct jtag_command *cmd)
+{
+       /* this is only allowed while in a stable state.  A check for a stable
+        * state was done in jtag_add_clocks()
+        */
+       unsigned int num_cycles = cmd->cmd.stableclocks->num_cycles;
+
+       /* 7 bits of either ones or zeros. */
+       uint8_t tms = tap_get_state() == TAP_RESET ? 0x7f : 0x00;
+
+       /* TODO: Use mpsse_clock_data with in=out=0 for this, if TMS can be set 
to
+        * the correct level and remain there during the scan */
+       while (num_cycles > 0) {
+               /* there are no state transitions in this code, so omit state 
tracking */
+               unsigned int this_len = num_cycles > 7 ? 7 : num_cycles;
+               mpsse_clock_tms_cs_out(mpsse_ctx, &tms, 0, this_len, false, 
ftdi_jtag_mode);
+               num_cycles -= this_len;
+       }
+
+       LOG_DEBUG_IO("clocks %u while in %s",
+               cmd->cmd.stableclocks->num_cycles,
+               tap_state_name(tap_get_state()));
+}
+
+static void mchp_ftdi_execute_command(struct jtag_command *cmd)
+{
+       switch (cmd->type) {
+               case JTAG_RUNTEST:
+                       mchp_ftdi_execute_runtest(cmd);
+                       break;
+               case JTAG_TLR_RESET:
+                       mchp_ftdi_execute_statemove(cmd);
+                       break;
+               case JTAG_PATHMOVE:
+                       mchp_ftdi_execute_pathmove(cmd);
+                       break;
+               case JTAG_SCAN:
+                       mchp_ftdi_execute_scan(cmd);
+                       break;
+               case JTAG_SLEEP:
+                       mchp_ftdi_execute_sleep(cmd);
+                       break;
+               case JTAG_STABLECLOCKS:
+                       mchp_ftdi_execute_stableclocks(cmd);
+                       break;
+               case JTAG_TMS:
+                       mchp_ftdi_execute_tms(cmd);
+                       break;
+               default:
+                       LOG_ERROR("BUG: unknown JTAG command type encountered: 
%d", cmd->type);
+                       break;
+       }
+}
+
+static int mchp_ftdi_execute_queue(struct jtag_command *cmd_queue)
+{
+       /* blink, if the current layout has that feature */
+       struct signal *led = find_signal_by_name("LED");
+       if (led)
+               mchp_ftdi_set_signal(led, '1');
+
+       for (struct jtag_command *cmd = cmd_queue; cmd; cmd = cmd->next) {
+               /* fill the write buffer with the desired command */
+               mchp_ftdi_execute_command(cmd);
+       }
+
+       if (led)
+               mchp_ftdi_set_signal(led, '0');
+
+       int retval = mpsse_flush(mpsse_ctx);
+       if (retval != ERROR_OK)
+               LOG_ERROR("error while flushing MPSSE queue: %d", retval);
+
+       return retval;
+}
+
+static int mchp_ftdi_initialize(void)
+{
+       if (tap_get_tms_path_len(TAP_IRPAUSE, TAP_IRPAUSE) == 7)
+               LOG_DEBUG("ftdi interface using 7 step jtag state transitions");
+       else
+               LOG_DEBUG("ftdi interface using shortest path jtag state 
transitions");
+
+       if (!ftdi_vid[0] && !ftdi_pid[0]) {
+               LOG_ERROR("Please specify ftdi vid_pid");
+               return ERROR_JTAG_INIT_FAILED;
+       }
+
+       mpsse_ctx = mpsse_open(ftdi_vid, ftdi_pid, ftdi_device_desc,
+                               adapter_get_required_serial(), 
adapter_usb_get_location(), ftdi_channel);
+       if (!mpsse_ctx)
+               return ERROR_JTAG_INIT_FAILED;
+
+       output = jtag_output_init;
+       direction = jtag_direction_init;
+
+       mpsse_set_data_bits_low_byte(mpsse_ctx, output & 0xff, direction & 
0xff);
+       mpsse_set_data_bits_high_byte(mpsse_ctx, output >> 8, direction >> 8);
+
+       mpsse_loopback_config(mpsse_ctx, false);
+
+       freq = mpsse_set_frequency(mpsse_ctx, adapter_get_speed_khz() * 1000);
+
+       return mpsse_flush(mpsse_ctx);
+}
+
+static int mchp_ftdi_quit(void)
+{
+       mpsse_close(mpsse_ctx);
+
+       struct signal *sig = signals;
+       while (sig) {
+               struct signal *next = sig->next;
+               free((void *)sig->name);
+               free(sig);
+               sig = next;
+       }
+
+       free(ftdi_device_desc);
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(mchp_ftdi_handle_device_desc_command)
+{
+       if (CMD_ARGC == 1) {
+               free(ftdi_device_desc);
+               ftdi_device_desc = strdup(CMD_ARGV[0]);
+       } else {
+               LOG_ERROR("expected exactly one argument to ftdi device_desc 
<description>");
+       }
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(mchp_ftdi_handle_channel_command)
+{
+       if (CMD_ARGC == 1)
+               COMMAND_PARSE_NUMBER(u8, CMD_ARGV[0], ftdi_channel);
+       else
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(mchp_ftdi_handle_layout_init_command)
+{
+       if (CMD_ARGC != 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], jtag_output_init);
+       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], jtag_direction_init);
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(mchp_ftdi_handle_layout_signal_command)
+{
+       if (CMD_ARGC < 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       bool invert_data = false;
+       uint16_t data_mask = 0;
+       bool invert_input = false;
+       uint16_t input_mask = 0;
+       bool invert_oe = false;
+       uint16_t oe_mask = 0;
+       for (unsigned int i = 1; i < CMD_ARGC; i += 2) {
+               if (strcmp("-data", CMD_ARGV[i]) == 0) {
+                       invert_data = false;
+                       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], data_mask);
+               } else if (strcmp("-ndata", CMD_ARGV[i]) == 0) {
+                       invert_data = true;
+                       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], data_mask);
+               } else if (strcmp("-input", CMD_ARGV[i]) == 0) {
+                       invert_input = false;
+                       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], input_mask);
+               } else if (strcmp("-ninput", CMD_ARGV[i]) == 0) {
+                       invert_input = true;
+                       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], input_mask);
+               } else if (strcmp("-oe", CMD_ARGV[i]) == 0) {
+                       invert_oe = false;
+                       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], oe_mask);
+               } else if (strcmp("-noe", CMD_ARGV[i]) == 0) {
+                       invert_oe = true;
+                       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], oe_mask);
+               } else if (!strcmp("-alias", CMD_ARGV[i]) ||
+                          !strcmp("-nalias", CMD_ARGV[i])) {
+                       if (!strcmp("-nalias", CMD_ARGV[i])) {
+                               invert_data = true;
+                               invert_input = true;
+                       }
+                       struct signal *sig = find_signal_by_name(CMD_ARGV[i + 
1]);
+                       if (!sig) {
+                               LOG_ERROR("signal %s is not defined", 
CMD_ARGV[i + 1]);
+                               return ERROR_FAIL;
+                       }
+                       data_mask = sig->data_mask;
+                       input_mask = sig->input_mask;
+                       oe_mask = sig->oe_mask;
+                       invert_input ^= sig->invert_input;
+                       invert_oe = sig->invert_oe;
+                       invert_data ^= sig->invert_data;
+               } else {
+                       LOG_ERROR("unknown option '%s'", CMD_ARGV[i]);
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+               }
+       }
+
+       struct signal *sig;
+       sig = find_signal_by_name(CMD_ARGV[0]);
+       if (!sig)
+               sig = create_signal(CMD_ARGV[0]);
+       if (!sig) {
+               LOG_ERROR("failed to create signal %s", CMD_ARGV[0]);
+               return ERROR_FAIL;
+       }
+
+       sig->invert_data = invert_data;
+       sig->data_mask = data_mask;
+       sig->invert_input = invert_input;
+       sig->input_mask = input_mask;
+       sig->invert_oe = invert_oe;
+       sig->oe_mask = oe_mask;
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(mchp_ftdi_handle_set_signal_command)
+{
+       if (CMD_ARGC < 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct signal *sig;
+       sig = find_signal_by_name(CMD_ARGV[0]);
+       if (!sig) {
+               LOG_ERROR("interface configuration doesn't define signal '%s'", 
CMD_ARGV[0]);
+               return ERROR_FAIL;
+       }
+
+       switch (*CMD_ARGV[1]) {
+       case '0':
+       case '1':
+       case 'z':
+       case 'Z':
+               /* single character level specifier only */
+               if (CMD_ARGV[1][1] == '\0') {
+                       mchp_ftdi_set_signal(sig, *CMD_ARGV[1]);
+                       break;
+               }
+               /* fallthrough */
+       default:
+               LOG_ERROR("unknown signal level '%s', use 0, 1 or z", 
CMD_ARGV[1]);
+               return ERROR_COMMAND_ARGUMENT_INVALID;
+       }
+
+       return mpsse_flush(mpsse_ctx);
+}
+
+COMMAND_HANDLER(mchp_ftdi_handle_get_signal_command)
+{
+       if (CMD_ARGC < 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct signal *sig;
+       uint16_t sig_data = 0;
+       sig = find_signal_by_name(CMD_ARGV[0]);
+       if (!sig) {
+               command_print(CMD, "interface configuration doesn't define 
signal '%s'", CMD_ARGV[0]);
+               return ERROR_FAIL;
+       }
+
+       int ret = mchp_ftdi_get_signal(sig, &sig_data);
+       if (ret != ERROR_OK)
+               return ret;
+
+       command_print(CMD, "%#06x", sig_data);
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(mchp_ftdi_handle_vid_pid_command)
+{
+       if (MAX_USB_IDS * 2 <= CMD_ARGC) {
+               LOG_WARNING("ignoring extra IDs in ftdi vid_pid "
+                       "(maximum is %d pairs)", MAX_USB_IDS);
+               CMD_ARGC = MAX_USB_IDS * 2;
+       }
+       if (CMD_ARGC < 2 || (CMD_ARGC & 1)) {
+               LOG_WARNING("incomplete ftdi vid_pid configuration directive");
+               if (CMD_ARGC < 2)
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+               /* remove the incomplete trailing id */
+               CMD_ARGC -= 1;
+       }
+
+       unsigned int i;
+       for (i = 0; i < CMD_ARGC; i += 2) {
+               COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i], ftdi_vid[i >> 1]);
+               COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], ftdi_pid[i >> 1]);
+       }
+
+       /*
+        * Explicitly terminate, in case there are multiples instances of
+        * ftdi vid_pid.
+        */
+       ftdi_vid[i >> 1] = 0;
+       ftdi_pid[i >> 1] = 0;
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(mchp_ftdi_init_bank_d_command)
+{
+       extern void interface_d_init(void);
+       interface_d_init();
+       return ERROR_OK;
+}
+
+static const struct command_registration ftdi_subcommand_handlers[] = {
+       {
+               .name = "device_desc",
+               .handler = &mchp_ftdi_handle_device_desc_command,
+               .mode = COMMAND_CONFIG,
+               .help = "set the USB device description of the FTDI device",
+               .usage = "description_string",
+       },
+       {
+               .name = "channel",
+               .handler = &mchp_ftdi_handle_channel_command,
+               .mode = COMMAND_CONFIG,
+               .help = "set the channel of the FTDI device that is used as 
JTAG",
+               .usage = "(0-3)",
+       },
+       {
+               .name = "layout_init",
+               .handler = &mchp_ftdi_handle_layout_init_command,
+               .mode = COMMAND_CONFIG,
+               .help = "initialize the FTDI GPIO signals used "
+                       "to control output-enables and reset signals",
+               .usage = "data direction",
+       },
+       {
+               .name = "layout_signal",
+               .handler = &mchp_ftdi_handle_layout_signal_command,
+               .mode = COMMAND_ANY,
+               .help = "define a signal controlled by one or more FTDI GPIO as 
data "
+                       "and/or output enable",
+               .usage = "name [-data mask|-ndata mask] [-oe mask|-noe mask] 
[-alias|-nalias name]",
+       },
+       {
+               .name = "set_signal",
+               .handler = &mchp_ftdi_handle_set_signal_command,
+               .mode = COMMAND_EXEC,
+               .help = "control a layout-specific signal",
+               .usage = "name (1|0|z)",
+       },
+       {
+               .name = "get_signal",
+               .handler = &mchp_ftdi_handle_get_signal_command,
+               .mode = COMMAND_EXEC,
+               .help = "read the value of a layout-specific signal",
+               .usage = "name",
+       },
+       {
+               .name = "vid_pid",
+               .handler = &mchp_ftdi_handle_vid_pid_command,
+               .mode = COMMAND_CONFIG,
+               .help = "the vendor ID and product ID of the FTDI device",
+               .usage = "(vid pid)*",
+       },
+       {
+               .name = "init_bank_d",
+               .handler = &mchp_ftdi_init_bank_d_command,
+               .mode = COMMAND_CONFIG,
+               .help = "for some devices, you may need to initialize bank d",
+               .usage = "init_bank_d"
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+static const struct command_registration ftdi_command_handlers[] = {
+       {
+               .name = "mchp_ftdi",
+               .mode = COMMAND_ANY,
+               .help = "perform ftdi management",
+               .chain = ftdi_subcommand_handlers,
+               .usage = "",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+
+static const char * const ftdi_transports[] = { "jtag", NULL };
+
+static struct jtag_interface ftdi_interface = {
+       .supported = DEBUG_CAP_TMS_SEQ,
+       .execute_queue = mchp_ftdi_execute_queue,
+};
+
+struct adapter_driver mchp_ftdi_adapter_driver = {
+       .name = "mchp_ftdi",
+       .transports = ftdi_transports,
+       .commands = ftdi_command_handlers,
+
+       .init = mchp_ftdi_initialize,
+       .quit = mchp_ftdi_quit,
+       .reset = mchp_ftdi_reset,
+       .speed = mchp_ftdi_speed,
+       .khz = mchp_ftdi_khz,
+       .speed_div = mchp_ftdi_speed_div,
+
+       .jtag_ops = &ftdi_interface,
+};
diff --git a/src/jtag/drivers/mchp_ftdi.c b/src/jtag/drivers/mchp_ftdi.c
new file mode 100644
index 0000000000..dfd129a847
--- /dev/null
+++ b/src/jtag/drivers/mchp_ftdi.c
@@ -0,0 +1,100 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+/***************************************************************************
+ *   Copyright (C) 2024 by Microchip Inc.                                  *
+ *   matteo.bonicol...@microchip.com                                       *
+ ***************************************************************************/
+
+#include <stdio.h>
+#include <stdlib.h>
+#include "config.h"
+#include "libftdi_helper.h"
+#include "helper/log.h"
+
+#define MCHP_FP5_VID (0x1514)
+#define MCHP_FP5_PID (0x2008)
+
+#define DD0_CTRL0                      (1)
+#define DD1_CTRL1                      (2)
+#define DD2_CTRL2                      (4)
+#define DD3_CTRL3                      (8)
+#define DD4_PROG_MODE                  (0x10)
+#define DD5_VJTAG_SPI_PWR_ENB_OFF      (0x20) /* (Low - on, High - Off */
+#define DD6_VJTAG_DEBUG_PWR_ENB_OFF    (0x40) /* (Low - on, High - Off */
+#define DD7_VPUMP_PWR_ENB_OFF          (0x80) /* (Low - on, High - Off */
+
+int interface_d_init(void)
+{
+       struct ftdi_device_list *devlist, *curdev;
+       struct ftdi_context ftdic;
+       unsigned char pins = DD0_CTRL0 | DD1_CTRL1 | DD2_CTRL2 | DD3_CTRL3 |
+                       DD6_VJTAG_DEBUG_PWR_ENB_OFF;
+       uint16_t ftdi_vid = MCHP_FP5_VID;
+       uint16_t ftdi_pid = MCHP_FP5_PID;
+       int err;
+
+       err = ftdi_init(&ftdic);
+       if (err) {
+               LOG_ERROR("ftdi_init() failed: %d (%s)", err, 
ftdi_get_error_string(&ftdic));
+               return err;
+       }
+
+       err = ftdi_usb_find_all(&ftdic, &devlist, ftdi_vid, ftdi_pid);
+       if (err < 0) {
+               LOG_ERROR("ftdi_usb_find_all() failed: %d (%s)", err, 
ftdi_get_error_string(&ftdic));
+               return err;
+       }
+
+       if (err == 0) {
+               LOG_INFO("Found no FP5 devices");
+               return err;
+       }
+
+       LOG_INFO("Found %d FP5 device%s\n", err, err > 1 ? "s" : "");
+       curdev = devlist;
+       while (curdev) {
+               err = ftdi_set_interface(&ftdic, INTERFACE_D);
+               if (err < 0) {
+                       LOG_ERROR("ftdi_set_interface failed: %d (%s)", err, 
ftdi_get_error_string(&ftdic));
+                       exit(0);
+               }
+
+               err = ftdi_usb_open_dev(&ftdic, curdev->dev);
+               if (err < 0) {
+                       LOG_ERROR("ftdi_usb_open_dev failed: %d (%s)", err, 
ftdi_get_error_string(&ftdic));
+                       exit(0);
+               }
+               LOG_DEBUG("Opened FP5's interface D");
+
+               err = ftdi_set_bitmode(&ftdic, 0xff, 0x01);
+               if (err) {
+                       LOG_ERROR("ftdi_set_bitmode failed: %d (%s)", err, 
ftdi_get_error_string(&ftdic));
+                       exit(0);
+               }
+
+               err = ftdi_write_data(&ftdic, &pins, sizeof(pins));
+               if (err != sizeof(pins)) {
+                       LOG_ERROR("ftdi_write_data failed: %d (%s)", err, 
ftdi_get_error_string(&ftdic));
+                       exit(0);
+               }
+
+               err = ftdi_read_data(&ftdic, &pins, sizeof(pins));
+               if (err != sizeof(pins)) {
+                       LOG_ERROR("ftdi_read_data failed: %d (%s)", err, 
ftdi_get_error_string(&ftdic));
+                       exit(0);
+               }
+               LOG_DEBUG("Set pins on interface D to 0x%x", pins);
+
+               err = ftdi_usb_close(&ftdic);
+               if (err) {
+                       LOG_ERROR("ftdi_usb_close failed: %d (%s)", err, 
ftdi_get_error_string(&ftdic));
+                       exit(0);
+               }
+               LOG_DEBUG("Closed FP5's interface D");
+
+               curdev = curdev->next;
+       }
+       ftdi_list_free(&devlist);
+
+       return ERROR_OK;
+}
diff --git a/src/jtag/interface.h b/src/jtag/interface.h
index 72634c6286..4ac30cd95d 100644
--- a/src/jtag/interface.h
+++ b/src/jtag/interface.h
@@ -405,4 +405,5 @@ extern struct adapter_driver xds110_adapter_driver;
 extern struct adapter_driver xlnx_pcie_xvc_adapter_driver;
 extern struct adapter_driver mchp_fp6_adapter_driver;
 extern struct adapter_driver mchp_efp6_adapter_driver;
+extern struct adapter_driver mchp_ftdi_adapter_driver;
 #endif /* OPENOCD_JTAG_INTERFACE_H */
diff --git a/src/jtag/interfaces.c b/src/jtag/interfaces.c
index 756a635efb..8dd555a0a2 100644
--- a/src/jtag/interfaces.c
+++ b/src/jtag/interfaces.c
@@ -158,6 +158,9 @@ struct adapter_driver *adapter_drivers[] = {
 #endif
 #if BUILD_MICROCHIP_EFP6 == 1
                &mchp_efp6_adapter_driver,
+#endif
+#if BUILD_MICROCHIP_FP5_FTDI == 1
+               &mchp_ftdi_adapter_driver,
 #endif
                NULL,
        };
diff --git a/tcl/board/microchip_riscv_fp5.cfg 
b/tcl/board/microchip_riscv_fp5.cfg
new file mode 100644
index 0000000000..0c708e43b2
--- /dev/null
+++ b/tcl/board/microchip_riscv_fp5.cfg
@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: GPL-2.0-or-later
+#**************************************************************************
+#   Copyright (C) 2015-2018 by Microchip Technology Inc.                  *
+#   http://www.microchip.com/support                                      *
+#                                                                         *
+#   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/>. *
+#**************************************************************************
+
+#------------------------------------------------------------------------------
+# Microchip RISC-V board
+#------------------------------------------------------------------------------
+
+# Device
+source [find interface/flashpro5.cfg]
+source [find target/microchip_riscv.cfg]
+
+# Board specific initialization
+proc do_board_reset_init {} {
+       # doesn't appear to be called
+}
diff --git a/tcl/interface/flashpro5.cfg b/tcl/interface/flashpro5.cfg
new file mode 100644
index 0000000000..ae418d16b9
--- /dev/null
+++ b/tcl/interface/flashpro5.cfg
@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+#
+# FlashPro5
+#
+
+adapter speed 6000
+
+adapter driver mchp_ftdi
+mchp_ftdi device_desc "FlashPro5"
+mchp_ftdi vid_pid 0x1514 0x2008
+mchp_ftdi init_bank_d
+
+# That FTDI has 4 channels (channel 0 and 1 are MPSSE-capable, 2 and 3 are 
bitbang
+mchp_ftdi channel 0
+
+# Initial Layout - data[0..15] direction[0..15]
+mchp_ftdi layout_init 0xff78 0xff7b
+#     Signal        Data    Direction       Notes
+# AD0 TCK           0       1 (out)         Port A TCK
+# AD1 TDI           0       1 (out)         Port A TDI
+# AD2 TDO           0       0 (in)          PORT A TDO
+# AD3 TMS           1       1 (out)         Port A TMS
+# AD4 GPIOL0        1       1 (out)         Port A TRST
+# AD5 GPIOL1        1       1 (out)         Enable Buff Prog
+# AD6 GPIOL2        1       1 (out)         Mux Sel Prog ADC
+# AD7 GPIOL3        0       0 (in)          GPIO Spare (Unused)
+
+# BD0 TCK           1       1 (out)         Port B TCK
+# BD1 TDI           1       1 (out)         Port B TDI
+# BD2 TDO           1       1 (out)         Port B TDO (unused)
+# BD3 TMS           1       1 (out)         Port B TMS
+# BD4 GPIOL0        1       1 (out)         Port B TRST
+# BD5 GPIOL1        1       1 (out)         Enable Buff SD
+# BD6 GPIOL2        1       1 (out)         Status LED B1
+# BD7 GPIOL2        1       1 (out)         Status LED B0
+
+# Signals definition
+mchp_ftdi layout_signal nTRST -data 0x0010

-- 

Reply via email to