ftdi: use "adapter usb location" instead of ftdi_location command
[openocd.git] / src / jtag / drivers / ftdi.c
index 8f47468b7e2d1f815b3f5336d71861629f68ffad..b709d28daaa678ffb1fd1c153ef49e0367e98579 100644 (file)
@@ -69,6 +69,7 @@
 #endif
 
 /* project specific includes */
+#include <jtag/drivers/jtag_usb_common.h>
 #include <jtag/interface.h>
 #include <jtag/swd.h>
 #include <transport/transport.h>
@@ -89,7 +90,6 @@
 
 static char *ftdi_device_desc;
 static char *ftdi_serial;
-static char *ftdi_location;
 static uint8_t ftdi_channel;
 static uint8_t ftdi_jtag_mode = JTAG_MODE;
 
@@ -105,8 +105,10 @@ 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;
 };
@@ -211,6 +213,32 @@ static int ftdi_set_signal(const struct signal *s, char value)
        return ERROR_OK;
 }
 
+static int 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
@@ -411,11 +439,11 @@ static void ftdi_execute_scan(struct jtag_command *cmd)
        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("discarding trailing empty field");
+               DEBUG_JTAG_IO("discarding trailing empty field");
        }
 
        if (cmd->cmd.scan->num_fields == 0) {
-               LOG_DEBUG("empty scan, doing nothing");
+               DEBUG_JTAG_IO("empty scan, doing nothing");
                return;
        }
 
@@ -630,7 +658,7 @@ static int ftdi_initialize(void)
 
        for (int i = 0; ftdi_vid[i] || ftdi_pid[i]; i++) {
                mpsse_ctx = mpsse_open(&ftdi_vid[i], &ftdi_pid[i], ftdi_device_desc,
-                               ftdi_serial, ftdi_location, ftdi_channel);
+                               ftdi_serial, jtag_usb_get_location(), ftdi_channel);
                if (mpsse_ctx)
                        break;
        }
@@ -666,6 +694,17 @@ static int 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);
+       free(ftdi_serial);
+
        free(swd_cmd_queue);
 
        return ERROR_OK;
@@ -697,21 +736,6 @@ COMMAND_HANDLER(ftdi_handle_serial_command)
        return ERROR_OK;
 }
 
-#ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
-COMMAND_HANDLER(ftdi_handle_location_command)
-{
-       if (CMD_ARGC == 1) {
-               if (ftdi_location)
-                       free(ftdi_location);
-               ftdi_location = strdup(CMD_ARGV[0]);
-       } else {
-               return ERROR_COMMAND_SYNTAX_ERROR;
-       }
-
-       return ERROR_OK;
-}
-#endif
-
 COMMAND_HANDLER(ftdi_handle_channel_command)
 {
        if (CMD_ARGC == 1)
@@ -740,6 +764,8 @@ COMMAND_HANDLER(ftdi_handle_layout_signal_command)
 
        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 i = 1; i < CMD_ARGC; i += 2) {
@@ -749,6 +775,12 @@ COMMAND_HANDLER(ftdi_handle_layout_signal_command)
                } 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);
@@ -757,15 +789,19 @@ COMMAND_HANDLER(ftdi_handle_layout_signal_command)
                        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]))
+                       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 {
@@ -785,6 +821,8 @@ COMMAND_HANDLER(ftdi_handle_layout_signal_command)
 
        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;
 
@@ -813,6 +851,7 @@ COMMAND_HANDLER(ftdi_handle_set_signal_command)
                        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_SYNTAX_ERROR;
@@ -821,6 +860,28 @@ COMMAND_HANDLER(ftdi_handle_set_signal_command)
        return mpsse_flush(mpsse_ctx);
 }
 
+COMMAND_HANDLER(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) {
+               LOG_ERROR("interface configuration doesn't define signal '%s'", CMD_ARGV[0]);
+               return ERROR_FAIL;
+       }
+
+       int ret = ftdi_get_signal(sig, &sig_data);
+       if (ret != ERROR_OK)
+               return ret;
+
+       LOG_USER("Signal %s = %#06x", sig->name, sig_data);
+
+       return ERROR_OK;
+}
+
 COMMAND_HANDLER(ftdi_handle_vid_pid_command)
 {
        if (CMD_ARGC > MAX_USB_IDS * 2) {
@@ -889,15 +950,6 @@ static const struct command_registration ftdi_command_handlers[] = {
                .help = "set the serial number of the FTDI device",
                .usage = "serial_string",
        },
-#ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
-       {
-               .name = "ftdi_location",
-               .handler = &ftdi_handle_location_command,
-               .mode = COMMAND_CONFIG,
-               .help = "set the USB bus location of the FTDI device",
-               .usage = "<bus>:port[,port]...",
-       },
-#endif
        {
                .name = "ftdi_channel",
                .handler = &ftdi_handle_channel_command,
@@ -928,6 +980,13 @@ static const struct command_registration ftdi_command_handlers[] = {
                .help = "control a layout-specific signal",
                .usage = "name (1|0|z)",
        },
+       {
+               .name = "ftdi_get_signal",
+               .handler = &ftdi_handle_get_signal_command,
+               .mode = COMMAND_EXEC,
+               .help = "read the value of a layout-specific signal",
+               .usage = "name",
+       },
        {
                .name = "ftdi_vid_pid",
                .handler = &ftdi_handle_vid_pid_command,
@@ -992,8 +1051,19 @@ static int ftdi_swd_init(void)
 static void ftdi_swd_swdio_en(bool enable)
 {
        struct signal *oe = find_signal_by_name("SWDIO_OE");
-       if (oe)
-               ftdi_set_signal(oe, enable ? '1' : '0');
+       if (oe) {
+               if (oe->data_mask)
+                       ftdi_set_signal(oe, enable ? '1' : '0');
+               else {
+                       /* Sets TDI/DO pin (pin 2) to input during rx when both pins are connected
+                          to SWDIO */
+                       if (enable)
+                               direction |= jtag_direction_init & 0x0002U;
+                       else
+                               direction &= ~0x0002U;
+                       mpsse_set_data_bits_low_byte(mpsse_ctx, output & 0xff, direction & 0xff);
+               }
+       }
 }
 
 /**
@@ -1003,12 +1073,12 @@ static void ftdi_swd_swdio_en(bool enable)
  */
 static int ftdi_swd_run_queue(void)
 {
-       LOG_DEBUG("Executing %zu queued transactions", swd_cmd_queue_length);
+       LOG_DEBUG_IO("Executing %zu queued transactions", swd_cmd_queue_length);
        int retval;
        struct signal *led = find_signal_by_name("LED");
 
        if (queued_retval != ERROR_OK) {
-               LOG_DEBUG("Skipping due to previous errors: %d", queued_retval);
+               LOG_DEBUG_IO("Skipping due to previous errors: %d", queued_retval);
                goto skip;
        }
 
@@ -1029,7 +1099,7 @@ static int ftdi_swd_run_queue(void)
        for (size_t i = 0; i < swd_cmd_queue_length; i++) {
                int ack = buf_get_u32(swd_cmd_queue[i].trn_ack_data_parity_trn, 1, 3);
 
-               LOG_DEBUG("%s %s %s reg %X = %08"PRIx32,
+               LOG_DEBUG_IO("%s %s %s reg %X = %08"PRIx32,
                                ack == SWD_ACK_OK ? "OK" : ack == SWD_ACK_WAIT ? "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK",
                                swd_cmd_queue[i].cmd & SWD_CMD_APnDP ? "AP" : "DP",
                                swd_cmd_queue[i].cmd & SWD_CMD_RnW ? "read" : "write",
@@ -1146,14 +1216,17 @@ static int ftdi_swd_switch_seq(enum swd_special_seq seq)
        switch (seq) {
        case LINE_RESET:
                LOG_DEBUG("SWD line reset");
+               ftdi_swd_swdio_en(true);
                mpsse_clock_data_out(mpsse_ctx, swd_seq_line_reset, 0, swd_seq_line_reset_len, SWD_MODE);
                break;
        case JTAG_TO_SWD:
                LOG_DEBUG("JTAG-to-SWD");
+               ftdi_swd_swdio_en(true);
                mpsse_clock_data_out(mpsse_ctx, swd_seq_jtag_to_swd, 0, swd_seq_jtag_to_swd_len, SWD_MODE);
                break;
        case SWD_TO_JTAG:
                LOG_DEBUG("SWD-to-JTAG");
+               ftdi_swd_swdio_en(true);
                mpsse_clock_data_out(mpsse_ctx, swd_seq_swd_to_jtag, 0, swd_seq_swd_to_jtag_len, SWD_MODE);
                break;
        default:

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)