jtag/drivers/bitbang: use LOG_CUSTOM_LEVEL() macro for SWD
[openocd.git] / src / jtag / drivers / bitbang.c
index 0b2783acaccaa4f70028c7c8abacbb07c52429ff..f0236848b34f95729aabf10ea0d491dcf360d74c 100644 (file)
@@ -1,4 +1,4 @@
-/* SPDX-License-Identifier: GPL-2.0-or-later */
+// SPDX-License-Identifier: GPL-2.0-or-later
 
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
@@ -15,6 +15,7 @@
 #include "config.h"
 #endif
 
+#include <jtag/jtag.h>      /* Added to avoid include loop in commands.h */
 #include "bitbang.h"
 #include <jtag/interface.h>
 #include <jtag/commands.h>
@@ -278,9 +279,18 @@ static int bitbang_scan(bool ir_scan, enum scan_type type, uint8_t *buffer,
        return ERROR_OK;
 }
 
-int bitbang_execute_queue(void)
+static void bitbang_sleep(unsigned int microseconds)
 {
-       struct jtag_command *cmd = jtag_command_queue;  /* currently processed command */
+       if (bitbang_interface->sleep) {
+               bitbang_interface->sleep(microseconds);
+       } else {
+               jtag_sleep(microseconds);
+       }
+}
+
+int bitbang_execute_queue(struct jtag_command *cmd_queue)
+{
+       struct jtag_command *cmd = cmd_queue;   /* currently processed command */
        int scan_size;
        enum scan_type type;
        uint8_t *buffer;
@@ -351,7 +361,9 @@ int bitbang_execute_queue(void)
                                break;
                        case JTAG_SLEEP:
                                LOG_DEBUG_IO("sleep %" PRIu32, cmd->cmd.sleep->us);
-                               jtag_sleep(cmd->cmd.sleep->us);
+                               if (bitbang_interface->flush && (bitbang_interface->flush() != ERROR_OK))
+                                       return ERROR_FAIL;
+                               bitbang_sleep(cmd->cmd.sleep->us);
                                break;
                        case JTAG_TMS:
                                retval = bitbang_execute_tms(cmd);
@@ -380,8 +392,6 @@ static int bitbang_swd_init(void)
 
 static void bitbang_swd_exchange(bool rnw, uint8_t buf[], unsigned int offset, unsigned int bit_cnt)
 {
-       LOG_DEBUG("bitbang_swd_exchange");
-
        if (bitbang_interface->blink) {
                /* FIXME: we should manage errors */
                bitbang_interface->blink(1);
@@ -412,11 +422,9 @@ static void bitbang_swd_exchange(bool rnw, uint8_t buf[], unsigned int offset, u
 
 static int bitbang_swd_switch_seq(enum swd_special_seq seq)
 {
-       LOG_DEBUG("bitbang_swd_switch_seq");
-
        switch (seq) {
        case LINE_RESET:
-               LOG_DEBUG("SWD line reset");
+               LOG_DEBUG_IO("SWD line reset");
                bitbang_swd_exchange(false, (uint8_t *)swd_seq_line_reset, 0, swd_seq_line_reset_len);
                break;
        case JTAG_TO_SWD:
@@ -459,7 +467,6 @@ static void swd_clear_sticky_errors(void)
 
 static void bitbang_swd_read_reg(uint8_t cmd, uint32_t *value, uint32_t ap_delay_clk)
 {
-       LOG_DEBUG("bitbang_swd_read_reg");
        assert(cmd & SWD_CMD_RNW);
 
        if (queued_retval != ERROR_OK) {
@@ -467,7 +474,7 @@ static void bitbang_swd_read_reg(uint8_t cmd, uint32_t *value, uint32_t ap_delay
                return;
        }
 
-       for (;;) {
+       for (unsigned int retry = 0;; retry++) {
                uint8_t trn_ack_data_parity_trn[DIV_ROUND_UP(4 + 3 + 32 + 1 + 4, 8)];
 
                cmd |= SWD_CMD_START | SWD_CMD_PARK;
@@ -481,16 +488,22 @@ static void bitbang_swd_read_reg(uint8_t cmd, uint32_t *value, uint32_t ap_delay
                uint32_t data = buf_get_u32(trn_ack_data_parity_trn, 1 + 3, 32);
                int parity = buf_get_u32(trn_ack_data_parity_trn, 1 + 3 + 32, 1);
 
-               LOG_DEBUG("%s %s read reg %X = %08"PRIx32,
-                         ack == SWD_ACK_OK ? "OK" : ack == SWD_ACK_WAIT ? "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK",
-                         cmd & SWD_CMD_APNDP ? "AP" : "DP",
-                         (cmd & SWD_CMD_A32) >> 1,
-                         data);
+               LOG_CUSTOM_LEVEL((ack != SWD_ACK_OK && (retry == 0 || ack != SWD_ACK_WAIT))
+                               ? LOG_LVL_DEBUG : LOG_LVL_DEBUG_IO,
+                       "%s %s read reg %X = %08" PRIx32,
+                       ack == SWD_ACK_OK ? "OK" : ack == SWD_ACK_WAIT ? "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK",
+                       cmd & SWD_CMD_APNDP ? "AP" : "DP",
+                       (cmd & SWD_CMD_A32) >> 1,
+                       data);
 
                if (ack == SWD_ACK_WAIT) {
                        swd_clear_sticky_errors();
                        continue;
-               } else if (ack != SWD_ACK_OK) {
+               }
+               if (retry > 1)
+                       LOG_DEBUG("SWD WAIT: retried %u times", retry);
+
+               if (ack != SWD_ACK_OK) {
                        queued_retval = swd_ack_to_error_code(ack);
                        return;
                }
@@ -510,7 +523,6 @@ static void bitbang_swd_read_reg(uint8_t cmd, uint32_t *value, uint32_t ap_delay
 
 static void bitbang_swd_write_reg(uint8_t cmd, uint32_t value, uint32_t ap_delay_clk)
 {
-       LOG_DEBUG("bitbang_swd_write_reg");
        assert(!(cmd & SWD_CMD_RNW));
 
        if (queued_retval != ERROR_OK) {
@@ -523,7 +535,7 @@ static void bitbang_swd_write_reg(uint8_t cmd, uint32_t value, uint32_t ap_delay
 
        /* init the array to silence scan-build */
        uint8_t trn_ack_data_parity_trn[DIV_ROUND_UP(4 + 3 + 32 + 1 + 4, 8)] = {0};
-       for (;;) {
+       for (unsigned int retry = 0;; retry++) {
                buf_set_u32(trn_ack_data_parity_trn, 1 + 3 + 1, 32, value);
                buf_set_u32(trn_ack_data_parity_trn, 1 + 3 + 1 + 32, 1, parity_u32(value));
 
@@ -531,27 +543,43 @@ static void bitbang_swd_write_reg(uint8_t cmd, uint32_t value, uint32_t ap_delay
                bitbang_swd_exchange(false, &cmd, 0, 8);
 
                bitbang_interface->swdio_drive(false);
-               bitbang_swd_exchange(true, trn_ack_data_parity_trn, 0, 1 + 3 + 1);
+               bitbang_swd_exchange(true, trn_ack_data_parity_trn, 0, 1 + 3);
+
+               /* Avoid a glitch on SWDIO when changing the direction to output.
+                * To keep performance penalty minimal, pre-write the first data
+                * bit to SWDIO GPIO output buffer while clocking the turnaround bit.
+                * Following swdio_drive(true) outputs the pre-written value
+                * and the same value is rewritten by the next swd_write()
+                * instead of glitching SWDIO
+                * HiZ/pull-up --------------> 0 -------------> 1
+                *           swdio_drive(true)   swd_write(0,1)
+                * in case of data bit 0 = 1
+                */
+               bitbang_swd_exchange(false, trn_ack_data_parity_trn, 1 + 3 + 1, 1);
                bitbang_interface->swdio_drive(true);
                bitbang_swd_exchange(false, trn_ack_data_parity_trn, 1 + 3 + 1, 32 + 1);
 
                int ack = buf_get_u32(trn_ack_data_parity_trn, 1, 3);
+               LOG_CUSTOM_LEVEL((check_ack && ack != SWD_ACK_OK && (retry == 0 || ack != SWD_ACK_WAIT))
+                               ? LOG_LVL_DEBUG : LOG_LVL_DEBUG_IO,
+                       "%s%s %s write reg %X = %08" PRIx32,
+                       check_ack ? "" : "ack ignored ",
+                       ack == SWD_ACK_OK ? "OK" : ack == SWD_ACK_WAIT ? "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK",
+                       cmd & SWD_CMD_APNDP ? "AP" : "DP",
+                       (cmd & SWD_CMD_A32) >> 1,
+                       buf_get_u32(trn_ack_data_parity_trn, 1 + 3 + 1, 32));
+
+               if (check_ack && ack == SWD_ACK_WAIT) {
+                       swd_clear_sticky_errors();
+                       continue;
+               }
 
-               LOG_DEBUG("%s%s %s write reg %X = %08"PRIx32,
-                         check_ack ? "" : "ack ignored ",
-                         ack == SWD_ACK_OK ? "OK" : ack == SWD_ACK_WAIT ? "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK",
-                         cmd & SWD_CMD_APNDP ? "AP" : "DP",
-                         (cmd & SWD_CMD_A32) >> 1,
-                         buf_get_u32(trn_ack_data_parity_trn, 1 + 3 + 1, 32));
-
-               if (check_ack) {
-                       if (ack == SWD_ACK_WAIT) {
-                               swd_clear_sticky_errors();
-                               continue;
-                       } else if (ack != SWD_ACK_OK) {
-                               queued_retval = swd_ack_to_error_code(ack);
-                               return;
-                       }
+               if (retry > 1)
+                       LOG_DEBUG("SWD WAIT: retried %u times", retry);
+
+               if (check_ack && ack != SWD_ACK_OK) {
+                       queued_retval = swd_ack_to_error_code(ack);
+                       return;
                }
 
                if (cmd & SWD_CMD_APNDP)
@@ -562,14 +590,13 @@ static void bitbang_swd_write_reg(uint8_t cmd, uint32_t value, uint32_t ap_delay
 
 static int bitbang_swd_run_queue(void)
 {
-       LOG_DEBUG("bitbang_swd_run_queue");
        /* A transaction must be followed by another transaction or at least 8 idle cycles to
         * ensure that data is clocked through the AP. */
        bitbang_swd_exchange(true, NULL, 0, 8);
 
        int retval = queued_retval;
        queued_retval = ERROR_OK;
-       LOG_DEBUG("SWD queue return value: %02x", retval);
+       LOG_DEBUG_IO("SWD queue return value: %02x", retval);
        return retval;
 }
 

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)