Code Review / openocd.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
target/xtensa: avoid IHI for writes to non-executable memory
[openocd.git] / src / jtag / drivers / kitprog.c
diff --git a/src/jtag/drivers/kitprog.c b/src/jtag/drivers/kitprog.c
index 7122d57575e177243a857621c7146ccc18712123..98b0d166810f73f297886157b1a0740d63f333c2 100644 (file)
--- a/src/jtag/drivers/kitprog.c
+++ b/src/jtag/drivers/kitprog.c
@@ -1,4 +1,4 @@
-/* SPDX-License-Identifier: GPL-2.0-or-later */
+// SPDX-License-Identifier: GPL-2.0-or-later
 
 /***************************************************************************
  *   Copyright (C) 2007 by Juergen Stuber <juergen@jstuber.net>            *
@@ -79,8 +79,24 @@
 #define HID_COMMAND_CONFIGURE  0x8f
 #define HID_COMMAND_BOOTLOADER 0xa0
 
-/* 512 bytes seems to work reliably */
-#define SWD_MAX_BUFFER_LENGTH 512
+/* 512 bytes seemed to work reliably.
+ * It works with both full queue of mostly reads or mostly writes.
+ *
+ * Unfortunately the commit 88f429ead019fd6df96ec15f0d897385f3cef0d0
+ * 5321: target/cortex_m: faster reading of all CPU registers
+ * revealed a serious Kitprog firmware problem:
+ * If the queue contains more than 63 transactions in the repeated pattern
+ * one write, two reads, the firmware fails badly.
+ * Sending 64 transactions makes the adapter to loose the connection with the
+ * device. Sending 65 or more transactions causes the adapter to stop
+ * receiving USB HID commands, next kitprog_hid_command() stops in hid_write().
+ *
+ * The problem was detected with KitProg v2.12 and v2.16.
+ * We can guess the problem is something like a buffer or stack overflow.
+ *
+ * Use shorter buffer as a workaround. 300 bytes (= 60 transactions) works.
+ */
+#define SWD_MAX_BUFFER_LENGTH 300
 
 struct kitprog {
        hid_device *hid_handle;
@@ -259,7 +275,7 @@ static int kitprog_usb_open(void)
        const uint16_t vids[] = { VID, 0 };
        const uint16_t pids[] = { PID, 0 };
 
-       if (jtag_libusb_open(vids, pids, &kitprog_handle->usb_handle, NULL) != ERROR_OK) {
+       if (jtag_libusb_open(vids, pids, NULL, &kitprog_handle->usb_handle, NULL) != ERROR_OK) {
                LOG_ERROR("Failed to open or find the device");
                return ERROR_FAIL;
        }
@@ -398,13 +414,13 @@ static int kitprog_set_protocol(uint8_t protocol)
        int transferred;
        char status = PROGRAMMER_NOK_NACK;
 
-       transferred = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
+       int retval = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
                LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
                CONTROL_TYPE_WRITE,
                (CONTROL_MODE_SET_PROGRAMMER_PROTOCOL << 8) | CONTROL_COMMAND_PROGRAM,
-               protocol, &status, 1, 0);
+               protocol, &status, 1, 0, &transferred);
 
-       if (transferred == 0) {
+       if (retval != ERROR_OK || transferred == 0) {
                LOG_DEBUG("Zero bytes transferred");
                return ERROR_FAIL;
        }
@@ -424,11 +440,11 @@ static int kitprog_get_status(void)
 
        /* Try a maximum of three times */
        for (int i = 0; (i < 3) && (transferred == 0); i++) {
-               transferred = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
+               jtag_libusb_control_transfer(kitprog_handle->usb_handle,
                        LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
                        CONTROL_TYPE_READ,
                        (CONTROL_MODE_POLL_PROGRAMMER_STATUS << 8) | CONTROL_COMMAND_PROGRAM,
-                       0, &status, 1, 0);
+                       0, &status, 1, 0, &transferred);
                jtag_sleep(1000);
        }
 
@@ -450,13 +466,13 @@ static int kitprog_set_unknown(void)
        int transferred;
        char status = PROGRAMMER_NOK_NACK;
 
-       transferred = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
+       int retval = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
                LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
                CONTROL_TYPE_WRITE,
                (0x03 << 8) | 0x04,
-               0, &status, 1, 0);
+               0, &status, 1, 0, &transferred);
 
-       if (transferred == 0) {
+       if (retval != ERROR_OK || transferred == 0) {
                LOG_DEBUG("Zero bytes transferred");
                return ERROR_FAIL;
        }
@@ -475,13 +491,13 @@ static int kitprog_acquire_psoc(uint8_t psoc_type, uint8_t acquire_mode,
        int transferred;
        char status = PROGRAMMER_NOK_NACK;
 
-       transferred = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
+       int retval = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
                LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
                CONTROL_TYPE_WRITE,
                (CONTROL_MODE_ACQUIRE_SWD_TARGET << 8) | CONTROL_COMMAND_PROGRAM,
-               (max_attempts << 8) | (acquire_mode << 4) | psoc_type, &status, 1, 0);
+               (max_attempts << 8) | (acquire_mode << 4) | psoc_type, &status, 1, 0, &transferred);
 
-       if (transferred == 0) {
+       if (retval != ERROR_OK || transferred == 0) {
                LOG_DEBUG("Zero bytes transferred");
                return ERROR_FAIL;
        }
@@ -499,13 +515,13 @@ static int kitprog_reset_target(void)
        int transferred;
        char status = PROGRAMMER_NOK_NACK;
 
-       transferred = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
+       int retval = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
                LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
                CONTROL_TYPE_WRITE,
                (CONTROL_MODE_RESET_TARGET << 8) | CONTROL_COMMAND_PROGRAM,
-               0, &status, 1, 0);
+               0, &status, 1, 0, &transferred);
 
-       if (transferred == 0) {
+       if (retval != ERROR_OK || transferred == 0) {
                LOG_DEBUG("Zero bytes transferred");
                return ERROR_FAIL;
        }
@@ -523,13 +539,13 @@ static int kitprog_swd_sync(void)
        int transferred;
        char status = PROGRAMMER_NOK_NACK;
 
-       transferred = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
+       int retval = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
                LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
                CONTROL_TYPE_WRITE,
                (CONTROL_MODE_SYNCHRONIZE_TRANSFER << 8) | CONTROL_COMMAND_PROGRAM,
-               0, &status, 1, 0);
+               0, &status, 1, 0, &transferred);
 
-       if (transferred == 0) {
+       if (retval != ERROR_OK || transferred == 0) {
                LOG_DEBUG("Zero bytes transferred");
                return ERROR_FAIL;
        }
@@ -547,13 +563,13 @@ static int kitprog_swd_seq(uint8_t seq_type)
        int transferred;
        char status = PROGRAMMER_NOK_NACK;
 
-       transferred = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
+       int retval = jtag_libusb_control_transfer(kitprog_handle->usb_handle,
                LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
                CONTROL_TYPE_WRITE,
                (CONTROL_MODE_SEND_SWD_SEQUENCE << 8) | CONTROL_COMMAND_PROGRAM,
-               seq_type, &status, 1, 0);
+               seq_type, &status, 1, 0, &transferred);
 
-       if (transferred == 0) {
+       if (retval != ERROR_OK || transferred == 0) {
                LOG_DEBUG("Zero bytes transferred");
                return ERROR_FAIL;
        }
@@ -766,7 +782,7 @@ static int kitprog_swd_run_queue(void)
                        if (ack != SWD_ACK_OK || (buffer[read_index] & 0x08)) {
                                LOG_DEBUG("SWD ack not OK: %d %s", i,
                                          ack == SWD_ACK_WAIT ? "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK");
-                               queued_retval = ack == SWD_ACK_WAIT ? ERROR_WAIT : ERROR_FAIL;
+                               queued_retval = swd_ack_to_error_code(ack);
                                break;
                        }
                        read_index++;
@@ -863,6 +879,13 @@ static const struct command_registration kitprog_subcommand_handlers[] = {
                .usage = "",
                .help = "try to acquire a PSoC",
        },
+       {
+               .name = "init_acquire_psoc",
+               .handler = &kitprog_handle_init_acquire_psoc_command,
+               .mode = COMMAND_CONFIG,
+               .help = "try to acquire a PSoC during init",
+               .usage = "",
+       },
        COMMAND_REGISTRATION_DONE
 };
 
@@ -874,13 +897,6 @@ static const struct command_registration kitprog_command_handlers[] = {
                .usage = "<cmd>",
                .chain = kitprog_subcommand_handlers,
        },
-       {
-               .name = "kitprog_init_acquire_psoc",
-               .handler = &kitprog_handle_init_acquire_psoc_command,
-               .mode = COMMAND_CONFIG,
-               .help = "try to acquire a PSoC during init",
-               .usage = "",
-       },
        COMMAND_REGISTRATION_DONE
 };
 
Open On-Chip Debugger

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)