jtag/core: Use 'bool' data type for 'bypass'
[openocd.git] / src / jtag / drivers / bitbang.c
index e5df3cf4074d04e1f4c4c55c2cd0562ea385a04d..665dbf329e09cb516700a1e439a6339f6a2f81aa 100644 (file)
@@ -1,22 +1,11 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
  *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
- *                                                                         *
- *   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/>. *
  ***************************************************************************/
 
 /* 2014-12: Addition of the SWD protocol support is based on the initial work
@@ -358,11 +347,10 @@ int bitbang_execute_queue(void)
                                        return ERROR_FAIL;
                                if (jtag_read_buffer(buffer, cmd->cmd.scan) != ERROR_OK)
                                        retval = ERROR_JTAG_QUEUE_FAILED;
-                               if (buffer)
-                                       free(buffer);
+                               free(buffer);
                                break;
                        case JTAG_SLEEP:
-                               LOG_DEBUG_IO("sleep %" PRIi32, cmd->cmd.sleep->us);
+                               LOG_DEBUG_IO("sleep %" PRIu32, cmd->cmd.sleep->us);
                                jtag_sleep(cmd->cmd.sleep->us);
                                break;
                        case JTAG_TMS:
@@ -382,28 +370,27 @@ int bitbang_execute_queue(void)
        return retval;
 }
 
-
-bool swd_mode;
 static int queued_retval;
 
 static int bitbang_swd_init(void)
 {
        LOG_DEBUG("bitbang_swd_init");
-       swd_mode = true;
        return ERROR_OK;
 }
 
-static void bitbang_exchange(bool rnw, uint8_t buf[], unsigned int offset, unsigned int bit_cnt)
+static void bitbang_swd_exchange(bool rnw, uint8_t buf[], unsigned int offset, unsigned int bit_cnt)
 {
-       LOG_DEBUG("bitbang_exchange");
-       int tdi;
+       if (bitbang_interface->blink) {
+               /* FIXME: we should manage errors */
+               bitbang_interface->blink(1);
+       }
 
        for (unsigned int i = offset; i < bit_cnt + offset; i++) {
                int bytec = i/8;
                int bcval = 1 << (i % 8);
-               tdi = !rnw && (buf[bytec] & bcval);
+               int swdio = !rnw && (buf[bytec] & bcval);
 
-               bitbang_interface->write(0, 0, tdi);
+               bitbang_interface->swd_write(0, swdio);
 
                if (rnw && buf) {
                        if (bitbang_interface->swdio_read())
@@ -412,26 +399,45 @@ static void bitbang_exchange(bool rnw, uint8_t buf[], unsigned int offset, unsig
                                buf[bytec] &= ~bcval;
                }
 
-               bitbang_interface->write(1, 0, tdi);
+               bitbang_interface->swd_write(1, swdio);
+       }
+
+       if (bitbang_interface->blink) {
+               /* FIXME: we should manage errors */
+               bitbang_interface->blink(0);
        }
 }
 
 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");
-               bitbang_exchange(false, (uint8_t *)swd_seq_line_reset, 0, swd_seq_line_reset_len);
+               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:
                LOG_DEBUG("JTAG-to-SWD");
-               bitbang_exchange(false, (uint8_t *)swd_seq_jtag_to_swd, 0, swd_seq_jtag_to_swd_len);
+               bitbang_swd_exchange(false, (uint8_t *)swd_seq_jtag_to_swd, 0, swd_seq_jtag_to_swd_len);
+               break;
+       case JTAG_TO_DORMANT:
+               LOG_DEBUG("JTAG-to-DORMANT");
+               bitbang_swd_exchange(false, (uint8_t *)swd_seq_jtag_to_dormant, 0, swd_seq_jtag_to_dormant_len);
                break;
        case SWD_TO_JTAG:
                LOG_DEBUG("SWD-to-JTAG");
-               bitbang_exchange(false, (uint8_t *)swd_seq_swd_to_jtag, 0, swd_seq_swd_to_jtag_len);
+               bitbang_swd_exchange(false, (uint8_t *)swd_seq_swd_to_jtag, 0, swd_seq_swd_to_jtag_len);
+               break;
+       case SWD_TO_DORMANT:
+               LOG_DEBUG("SWD-to-DORMANT");
+               bitbang_swd_exchange(false, (uint8_t *)swd_seq_swd_to_dormant, 0, swd_seq_swd_to_dormant_len);
+               break;
+       case DORMANT_TO_SWD:
+               LOG_DEBUG("DORMANT-to-SWD");
+               bitbang_swd_exchange(false, (uint8_t *)swd_seq_dormant_to_swd, 0, swd_seq_dormant_to_swd_len);
+               break;
+       case DORMANT_TO_JTAG:
+               LOG_DEBUG("DORMANT-to-JTAG");
+               bitbang_swd_exchange(false, (uint8_t *)swd_seq_dormant_to_jtag, 0, swd_seq_dormant_to_jtag_len);
                break;
        default:
                LOG_ERROR("Sequence %d not supported", seq);
@@ -449,8 +455,7 @@ 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);
+       assert(cmd & SWD_CMD_RNW);
 
        if (queued_retval != ERROR_OK) {
                LOG_DEBUG("Skip bitbang_swd_read_reg because queued_retval=%d", queued_retval);
@@ -460,114 +465,116 @@ static void bitbang_swd_read_reg(uint8_t cmd, uint32_t *value, uint32_t ap_delay
        for (;;) {
                uint8_t trn_ack_data_parity_trn[DIV_ROUND_UP(4 + 3 + 32 + 1 + 4, 8)];
 
-               cmd |= SWD_CMD_START | (1 << 7);
-               bitbang_exchange(false, &cmd, 0, 8);
+               cmd |= SWD_CMD_START | SWD_CMD_PARK;
+               bitbang_swd_exchange(false, &cmd, 0, 8);
 
                bitbang_interface->swdio_drive(false);
-               bitbang_exchange(true, trn_ack_data_parity_trn, 0, 1 + 3 + 32 + 1 + 1);
+               bitbang_swd_exchange(true, trn_ack_data_parity_trn, 0, 1 + 3 + 32 + 1 + 1);
                bitbang_interface->swdio_drive(true);
 
                int ack = buf_get_u32(trn_ack_data_parity_trn, 1, 3);
                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 %s reg %X = %08"PRIx32,
+               LOG_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_RnW ? "read" : "write",
+                         cmd & SWD_CMD_APNDP ? "AP" : "DP",
                          (cmd & SWD_CMD_A32) >> 1,
                          data);
 
-               switch (ack) {
-                case SWD_ACK_OK:
-                       if (parity != parity_u32(data)) {
-                               LOG_DEBUG("Wrong parity detected");
-                               queued_retval = ERROR_FAIL;
-                               return;
-                       }
-                       if (value)
-                               *value = data;
-                       if (cmd & SWD_CMD_APnDP)
-                               bitbang_exchange(true, NULL, 0, ap_delay_clk);
-                       return;
-                case SWD_ACK_WAIT:
-                       LOG_DEBUG("SWD_ACK_WAIT");
+               if (ack == SWD_ACK_WAIT) {
                        swd_clear_sticky_errors();
-                       break;
-                case SWD_ACK_FAULT:
-                       LOG_DEBUG("SWD_ACK_FAULT");
-                       queued_retval = ack;
+                       continue;
+               } else if (ack != SWD_ACK_OK) {
+                       queued_retval = swd_ack_to_error_code(ack);
                        return;
-                default:
-                       LOG_DEBUG("No valid acknowledge: ack=%d", ack);
-                       queued_retval = ack;
+               }
+
+               if (parity != parity_u32(data)) {
+                       LOG_ERROR("Wrong parity detected");
+                       queued_retval = ERROR_FAIL;
                        return;
                }
+               if (value)
+                       *value = data;
+               if (cmd & SWD_CMD_APNDP)
+                       bitbang_swd_exchange(true, NULL, 0, ap_delay_clk);
+               return;
        }
 }
 
 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));
+       assert(!(cmd & SWD_CMD_RNW));
 
        if (queued_retval != ERROR_OK) {
                LOG_DEBUG("Skip bitbang_swd_write_reg because queued_retval=%d", queued_retval);
                return;
        }
 
+       /* Devices do not reply to DP_TARGETSEL write cmd, ignore received ack */
+       bool check_ack = swd_cmd_returns_ack(cmd);
+
+       /* 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 (;;) {
-               uint8_t trn_ack_data_parity_trn[DIV_ROUND_UP(4 + 3 + 32 + 1 + 4, 8)];
                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));
 
-               cmd |= SWD_CMD_START | (1 << 7);
-               bitbang_exchange(false, &cmd, 0, 8);
+               cmd |= SWD_CMD_START | SWD_CMD_PARK;
+               bitbang_swd_exchange(false, &cmd, 0, 8);
 
                bitbang_interface->swdio_drive(false);
-               bitbang_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_exchange(false, trn_ack_data_parity_trn, 1 + 3 + 1, 32 + 1);
+               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_DEBUG("%s %s %s reg %X = %08"PRIx32,
+
+               LOG_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_RnW ? "read" : "write",
+                         cmd & SWD_CMD_APNDP ? "AP" : "DP",
                          (cmd & SWD_CMD_A32) >> 1,
                          buf_get_u32(trn_ack_data_parity_trn, 1 + 3 + 1, 32));
 
-               switch (ack) {
-                case SWD_ACK_OK:
-                       if (cmd & SWD_CMD_APnDP)
-                               bitbang_exchange(true, NULL, 0, ap_delay_clk);
-                       return;
-                case SWD_ACK_WAIT:
-                       LOG_DEBUG("SWD_ACK_WAIT");
-                       swd_clear_sticky_errors();
-                       break;
-                case SWD_ACK_FAULT:
-                       LOG_DEBUG("SWD_ACK_FAULT");
-                       queued_retval = ack;
-                       return;
-                default:
-                       LOG_DEBUG("No valid acknowledge: ack=%d", ack);
-                       queued_retval = ack;
-                       return;
+               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 (cmd & SWD_CMD_APNDP)
+                       bitbang_swd_exchange(true, NULL, 0, ap_delay_clk);
+               return;
        }
 }
 
 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_exchange(true, NULL, 0, 8);
+       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)