// SPDX-License-Identifier: GPL-2.0-or-later /*************************************************************************** * 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 * ***************************************************************************/ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #include "cmsis_dap.h" struct cmsis_dap_backend_data { hid_device *dev_handle; }; 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 int cmsis_dap_hid_open(struct cmsis_dap *dap, uint16_t vids[], uint16_t pids[], const 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 (cur_dev) { bool found = false; 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")) { /* 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) break; if (cur_dev->serial_number) { 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 (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) { LOG_ERROR("unable to allocate memory"); return ERROR_FAIL; } dev = hid_open_path(cur_dev->path); hid_free_enumeration(devs); if (!dev) { 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 */ 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 */ /* 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; dap->bdata->dev_handle = dev; int retval = cmsis_dap_hid_alloc(dap, packet_size); if (retval != ERROR_OK) { cmsis_dap_hid_close(dap); return ERROR_FAIL; } dap->command = dap->packet_buffer + REPORT_ID_SIZE; dap->response = dap->packet_buffer; 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; free(dap->packet_buffer); dap->packet_buffer = 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_buffer_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; dap->packet_buffer[0] = 0; /* HID report number */ /* Pad the rest of the TX buffer with 0's */ memset(dap->command + txlen, 0, dap->packet_size - txlen); /* write data to device */ int retval = hid_write(dap->bdata->dev_handle, dap->packet_buffer, dap->packet_buffer_size); if (retval == -1) { LOG_ERROR("error writing data: %ls", hid_error(dap->bdata->dev_handle)); return ERROR_FAIL; } return retval; } 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) { LOG_ERROR("unable to allocate CMSIS-DAP packet buffer"); return ERROR_FAIL; } dap->packet_buffer = buf; dap->packet_size = pkt_sz; dap->packet_buffer_size = packet_buffer_size; dap->command = dap->packet_buffer + REPORT_ID_SIZE; dap->response = dap->packet_buffer; return ERROR_OK; } 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, .packet_buffer_alloc = cmsis_dap_hid_alloc, };