jtag: add -ir-bypass option to newtap
[openocd.git] / src / jtag / drivers / cmsis_dap_usb_hid.c
index e83ad1feb1193296fda056fc4344026bd9679fa4..98ccc3e381b3f7ddb5a4549a5556e3b38b50ae9f 100644 (file)
@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2018 by MickaĆ«l Thomas                                  *
  *   mickael9@gmail.com                                                    *
  *                                                                         *
  *   Copyright (C) 2013 by Spencer Oliver                                  *
  *   spen@spen-soft.co.uk                                                  *
- *                                                                         *
- *   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/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
+#include <string.h>
 #include <hidapi.h>
 #include <helper/log.h>
 
@@ -44,10 +34,41 @@ struct cmsis_dap_backend_data {
        hid_device *dev_handle;
 };
 
+struct cmsis_dap_report_size {
+       unsigned short vid;
+       unsigned short pid;
+       unsigned int report_size;
+};
+
+static const struct cmsis_dap_report_size report_size_quirks[] = {
+       /* Third gen Atmel tools use a report size of 512 */
+    /* This list of PIDs comes from toolinfo.py in Microchip's pyedbglib. */
+       // Atmel JTAG-ICE 3
+       { .vid = 0x03eb, .pid = 0x2140, .report_size = 512 },
+       // Atmel-ICE
+       { .vid = 0x03eb, .pid = 0x2141, .report_size = 512 },
+       // Atmel Power Debugger
+       { .vid = 0x03eb, .pid = 0x2144, .report_size = 512 },
+       // EDBG (found on Xplained Pro boards)
+       { .vid = 0x03eb, .pid = 0x2111, .report_size = 512 },
+       // Zero (???)
+       { .vid = 0x03eb, .pid = 0x2157, .report_size = 512 },
+       // EDBG with Mass Storage (found on Xplained Pro boards)
+       { .vid = 0x03eb, .pid = 0x2169, .report_size = 512 },
+       // Commercially available EDBG (for third-party use)
+       { .vid = 0x03eb, .pid = 0x216a, .report_size = 512 },
+       // Kraken (???)
+       { .vid = 0x03eb, .pid = 0x2170, .report_size = 512 },
+
+       { .vid = 0, .pid = 0, .report_size = 0 }
+};
+
+
 static void cmsis_dap_hid_close(struct cmsis_dap *dap);
 static int cmsis_dap_hid_alloc(struct cmsis_dap *dap, unsigned int pkt_sz);
+static void cmsis_dap_hid_free(struct cmsis_dap *dap);
 
-static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t pids[], char *serial)
+static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t pids[], const char *serial)
 {
        hid_device *dev = NULL;
        int i;
@@ -69,11 +90,11 @@ static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t p
         */
        devs = hid_enumerate(0x0, 0x0);
        cur_dev = devs;
-       while (NULL != cur_dev) {
+       while (cur_dev) {
                bool found = false;
 
-               if (0 == vids[0]) {
-                       if (NULL == cur_dev->product_string) {
+               if (vids[0] == 0) {
+                       if (!cur_dev->product_string) {
                                LOG_DEBUG("Cannot read product string of device 0x%x:0x%x",
                                          cur_dev->vendor_id, cur_dev->product_id);
                        } else if (wcsstr(cur_dev->product_string, L"CMSIS-DAP")) {
@@ -96,10 +117,10 @@ static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t p
 
                if (found) {
                        /* check serial number matches if given */
-                       if (serial == NULL)
+                       if (!serial)
                                break;
 
-                       if (cur_dev->serial_number != NULL) {
+                       if (cur_dev->serial_number) {
                                size_t len = (strlen(serial) + 1) * sizeof(wchar_t);
                                wchar_t *wserial = malloc(len);
                                mbstowcs(wserial, serial, len);
@@ -117,7 +138,7 @@ static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t p
                cur_dev = cur_dev->next;
        }
 
-       if (NULL != cur_dev) {
+       if (cur_dev) {
                target_vid = cur_dev->vendor_id;
                target_pid = cur_dev->product_id;
        }
@@ -128,7 +149,7 @@ static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t p
        }
 
        dap->bdata = malloc(sizeof(struct cmsis_dap_backend_data));
-       if (dap->bdata == NULL) {
+       if (!dap->bdata) {
                LOG_ERROR("unable to allocate memory");
                return ERROR_FAIL;
        }
@@ -136,7 +157,7 @@ static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t p
        dev = hid_open_path(cur_dev->path);
        hid_free_enumeration(devs);
 
-       if (dev == NULL) {
+       if (!dev) {
                LOG_ERROR("unable to open CMSIS-DAP device 0x%x:0x%x", target_vid, target_pid);
                return ERROR_FAIL;
        }
@@ -148,13 +169,15 @@ static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t p
 
        unsigned int packet_size = 64;
 
-       /* atmel cmsis-dap uses 512 byte reports */
-       /* except when it doesn't e.g. with mEDBG on SAMD10 Xplained
-        * board */
+       /* Check for adapters that are known to have unusual report lengths. */
+       for (i = 0; report_size_quirks[i].vid != 0; i++) {
+               if (report_size_quirks[i].vid == target_vid &&
+                   report_size_quirks[i].pid == target_pid) {
+                       packet_size = report_size_quirks[i].report_size;
+               }
+       }
        /* TODO: HID report descriptor should be parsed instead of
-        * hardcoding a match by VID */
-       if (target_vid == 0x03eb && target_pid != 0x2145 && target_pid != 0x2175)
-               packet_size = 512;
+        * hardcoding a match by VID/PID */
 
        dap->bdata->dev_handle = dev;
 
@@ -175,14 +198,21 @@ static void cmsis_dap_hid_close(struct cmsis_dap *dap)
        hid_exit();
        free(dap->bdata);
        dap->bdata = NULL;
-       free(dap->packet_buffer);
-       dap->packet_buffer = NULL;
+       cmsis_dap_hid_free(dap);
 }
 
-static int cmsis_dap_hid_read(struct cmsis_dap *dap, int timeout_ms)
+static int cmsis_dap_hid_read(struct cmsis_dap *dap, int transfer_timeout_ms,
+                                                         struct timeval *wait_timeout)
 {
-       int retval = hid_read_timeout(dap->bdata->dev_handle, dap->packet_buffer, dap->packet_buffer_size, timeout_ms);
-
+       int timeout_ms;
+       if (wait_timeout)
+               timeout_ms = wait_timeout->tv_usec / 1000 + wait_timeout->tv_sec * 1000;
+       else
+               timeout_ms = transfer_timeout_ms;
+
+       int retval = hid_read_timeout(dap->bdata->dev_handle,
+                                                                 dap->packet_buffer, dap->packet_buffer_size,
+                                                                 timeout_ms);
        if (retval == 0) {
                return ERROR_TIMEOUT_REACHED;
        } else if (retval == -1) {
@@ -216,13 +246,14 @@ static int cmsis_dap_hid_alloc(struct cmsis_dap *dap, unsigned int pkt_sz)
 {
        unsigned int packet_buffer_size = pkt_sz + REPORT_ID_SIZE;
        uint8_t *buf = malloc(packet_buffer_size);
-       if (buf == NULL) {
+       if (!buf) {
                LOG_ERROR("unable to allocate CMSIS-DAP packet buffer");
                return ERROR_FAIL;
        }
 
        dap->packet_buffer = buf;
        dap->packet_size = pkt_sz;
+       dap->packet_usable_size = pkt_sz;
        dap->packet_buffer_size = packet_buffer_size;
 
        dap->command = dap->packet_buffer + REPORT_ID_SIZE;
@@ -231,6 +262,16 @@ static int cmsis_dap_hid_alloc(struct cmsis_dap *dap, unsigned int pkt_sz)
        return ERROR_OK;
 }
 
+static void cmsis_dap_hid_free(struct cmsis_dap *dap)
+{
+       free(dap->packet_buffer);
+       dap->packet_buffer = NULL;
+}
+
+static void cmsis_dap_hid_cancel_all(struct cmsis_dap *dap)
+{
+}
+
 const struct cmsis_dap_backend cmsis_dap_hid_backend = {
        .name = "hid",
        .open = cmsis_dap_hid_open,
@@ -238,4 +279,6 @@ const struct cmsis_dap_backend cmsis_dap_hid_backend = {
        .read = cmsis_dap_hid_read,
        .write = cmsis_dap_hid_write,
        .packet_buffer_alloc = cmsis_dap_hid_alloc,
+       .packet_buffer_free = cmsis_dap_hid_free,
+       .cancel_all = cmsis_dap_hid_cancel_all,
 };

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)