Add CMSIS-DAP v2 support

This change implements CMSIS-DAP v2 which works with raw USB bulk transfers.

The old driver is now split into a generic CMSIS part and a HID backend,
with a new raw USB backend for CMSIS-DAP v2.

New commands:
- cmsis_dap_backend (usb_bulk | hid | auto)
- cmsis_dap_usb interface <interface number>

Change-Id: I4218477b12ccbfe19c9b332321cd21394bf44e30
Signed-off-by: Mickaël Thomas <mickael9@gmail.com>
Signed-off-by: Tomas Vanek <vanekt@fbl.cz>
Reviewed-on: http://openocd.zylin.com/4831
Tested-by: jenkins

1 files changed, 208 insertions, 0 deletions

diff --git a/src/jtag/drivers/cmsis_dap_usb_hid.c b/src/jtag/drivers/cmsis_dap_usb_hid.c
new file mode 100644
index 0000000..681aef1
--- /dev/null
+++ b/src/jtag/drivers/cmsis_dap_usb_hid.c
@@ -0,0 +1,208 @@
+/***************************************************************************
+ *   Copyright (C) 2018 by Mickaël Thomas                                  *
+ *   mickael9@gmail.com                                                    *
+ *                                                                         *
+ *   Copyright (C) 2016 by Maksym Hilliaka                                 *
+ *   oter@frozen-team.com                                                  *
+ *                                                                         *
+ *   Copyright (C) 2016 by Phillip Pearson                                 *
+ *   pp@myelin.co.nz                                                       *
+ *                                                                         *
+ *   Copyright (C) 2014 by Paul Fertser                                    *
+ *   fercerpav@gmail.com                                                   *
+ *                                                                         *
+ *   Copyright (C) 2013 by mike brown                                      *
+ *   mike@theshedworks.org.uk                                              *
+ *                                                                         *
+ *   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 <hidapi.h>
+#include <helper/log.h>
+
+#include "cmsis_dap.h"
+
+#define PACKET_SIZE       (64 + 1)	/* 64 bytes plus report id */
+
+struct cmsis_dap_backend_data {
+	hid_device *dev_handle;
+};
+
+static int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t pids[], char *serial)
+{
+	hid_device *dev = NULL;
+	int i;
+	struct hid_device_info *devs, *cur_dev;
+	unsigned short target_vid, target_pid;
+
+	target_vid = 0;
+	target_pid = 0;
+
+	if (hid_init() != 0) {
+		LOG_ERROR("unable to open HIDAPI");
+		return ERROR_FAIL;
+	}
+
+	/*
+	 * The CMSIS-DAP specification stipulates:
+	 * "The Product String must contain "CMSIS-DAP" somewhere in the string. This is used by the
+	 * debuggers to identify a CMSIS-DAP compliant Debug Unit that is connected to a host computer."
+	 */
+	devs = hid_enumerate(0x0, 0x0);
+	cur_dev = devs;
+	while (NULL != cur_dev) {
+		bool found = false;
+
+		if (0 == vids[0]) {
+			if (NULL == 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")) {
+				/* if the user hasn't specified VID:PID *and*
+				 * product string contains "CMSIS-DAP", pick it
+				 */
+				found = true;
+			}
+		} else {
+			/* otherwise, exhaustively compare against all VID:PID in list */
+			for (i = 0; vids[i] || pids[i]; i++) {
+				if ((vids[i] == cur_dev->vendor_id) && (pids[i] == cur_dev->product_id))
+					found = true;
+			}
+		}
+
+		/* LPC-LINK2 has cmsis-dap on interface 0 and other HID functions on other interfaces */
+		if (cur_dev->vendor_id == 0x1fc9 && cur_dev->product_id == 0x0090 && cur_dev->interface_number != 0)
+			found = false;
+
+		if (found) {
+			/* check serial number matches if given */
+			if (serial == NULL)
+				break;
+
+			if (cur_dev->serial_number != NULL) {
+				size_t len = (strlen(serial) + 1) * sizeof(wchar_t);
+				wchar_t *wserial = malloc(len);
+				mbstowcs(wserial, serial, len);
+
+				if (wcscmp(wserial, cur_dev->serial_number) == 0) {
+					free(wserial);
+					break;
+				} else {
+					free(wserial);
+					wserial = NULL;
+				}
+			}
+		}
+
+		cur_dev = cur_dev->next;
+	}
+
+	if (NULL != cur_dev) {
+		target_vid = cur_dev->vendor_id;
+		target_pid = cur_dev->product_id;
+	}
+
+	if (target_vid == 0 && target_pid == 0) {
+		hid_free_enumeration(devs);
+		return ERROR_FAIL;
+	}
+
+	dap->bdata = malloc(sizeof(struct cmsis_dap_backend_data));
+	if (dap->bdata == NULL) {
+		LOG_ERROR("unable to allocate memory");
+		return ERROR_FAIL;
+	}
+
+	dev = hid_open_path(cur_dev->path);
+	hid_free_enumeration(devs);
+
+	if (dev == NULL) {
+		LOG_ERROR("unable to open CMSIS-DAP device 0x%x:0x%x", target_vid, target_pid);
+		return ERROR_FAIL;
+	}
+
+	/* allocate default packet buffer, may be changed later.
+	 * currently with HIDAPI we have no way of getting the output report length
+	 * without this info we cannot communicate with the adapter.
+	 * For the moment we have to hard code the packet size */
+
+	dap->packet_size = PACKET_SIZE;
+
+	/* atmel cmsis-dap uses 512 byte reports */
+	/* except when it doesn't e.g. with mEDBG on SAMD10 Xplained
+	 * board */
+	/* TODO: HID report descriptor should be parsed instead of
+	 * hardcoding a match by VID */
+	if (target_vid == 0x03eb && target_pid != 0x2145 && target_pid != 0x2175)
+		dap->packet_size = 512 + 1;
+
+	dap->bdata->dev_handle = dev;
+
+	return ERROR_OK;
+}
+
+static void cmsis_dap_hid_close(struct cmsis_dap *dap)
+{
+	hid_close(dap->bdata->dev_handle);
+	hid_exit();
+	free(dap->bdata);
+	dap->bdata = NULL;
+}
+
+static int cmsis_dap_hid_read(struct cmsis_dap *dap, int timeout_ms)
+{
+	int retval = hid_read_timeout(dap->bdata->dev_handle, dap->packet_buffer, dap->packet_size, timeout_ms);
+
+	if (retval == 0) {
+		return ERROR_TIMEOUT_REACHED;
+	} else if (retval == -1) {
+		LOG_ERROR("error reading data: %ls", hid_error(dap->bdata->dev_handle));
+		return ERROR_FAIL;
+	}
+
+	return retval;
+}
+
+static int cmsis_dap_hid_write(struct cmsis_dap *dap, int txlen, int timeout_ms)
+{
+	(void) timeout_ms;
+
+	/* Pad the rest of the TX buffer with 0's */
+	memset(dap->packet_buffer + txlen, 0, dap->packet_size - txlen);
+
+	/* write data to device */
+	int retval = hid_write(dap->bdata->dev_handle, dap->packet_buffer, dap->packet_size);
+	if (retval == -1) {
+		LOG_ERROR("error writing data: %ls", hid_error(dap->bdata->dev_handle));
+		return ERROR_FAIL;
+	}
+
+	return retval;
+}
+
+const struct cmsis_dap_backend cmsis_dap_hid_backend = {
+	.name = "hid",
+	.open = cmsis_dap_hid_open,
+	.close = cmsis_dap_hid_close,
+	.read = cmsis_dap_hid_read,
+	.write = cmsis_dap_hid_write,
+};