cmsis-dap: add serial number support
[openocd.git] / src / jtag / drivers / cmsis_dap_usb.c
index 180a91b40b4293e234564420d8eae4c99c0eed45..95f553b626f147e6718a1399a3d4ad6ee5626105 100644 (file)
@@ -60,6 +60,8 @@
 /* vid = pid = 0 marks the end of the list */
 static uint16_t cmsis_dap_vid[MAX_USB_IDS + 1] = { 0 };
 static uint16_t cmsis_dap_pid[MAX_USB_IDS + 1] = { 0 };
+static wchar_t *cmsis_dap_serial;
+static bool swd_mode;
 
 #define PACKET_SIZE       (64 + 1)     /* 64 bytes plus report id */
 #define USB_TIMEOUT       1000
@@ -136,7 +138,7 @@ static uint16_t cmsis_dap_pid[MAX_USB_IDS + 1] = { 0 };
 /* CMSIS-DAP Vendor Commands
  * None as yet... */
 
-static char *info_caps_str[] = {
+static const char * const info_caps_str[] = {
        "SWD  Supported",
        "JTAG Supported"
 };
@@ -162,14 +164,16 @@ static int cmsis_dap_usb_open(void)
        struct hid_device_info *devs, *cur_dev;
        unsigned short target_vid, target_pid;
 
+       bool found = false;
+
        target_vid = 0;
        target_pid = 0;
 
        /*
-       The CMSIS-DAP specification stipulates:
-       "The Product String must contain "CMSIS-DAP" somewhere in the string. This is used by the
-       debuggers to idenify a CMSIS-DAP compliant Debug Unit that is connected to a host computer."
-       */
+        * 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) {
@@ -178,21 +182,32 @@ static int cmsis_dap_usb_open(void)
                                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
-                                       */
-                                       break;
+                               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
-                       */
+                       /* otherwise, exhaustively compare against all VID:PID in list */
                        for (i = 0; cmsis_dap_vid[i] || cmsis_dap_pid[i]; i++) {
                                if ((cmsis_dap_vid[i] == cur_dev->vendor_id) && (cmsis_dap_pid[i] == cur_dev->product_id))
-                                       break;
+                                       found = true;
                        }
+
+                       if (cmsis_dap_vid[i] || cmsis_dap_pid[i])
+                               found = true;
+               }
+
+               if (found) {
+                       /* we have found an adapter, so exit further checks */
+                       /* check serial number matches if given */
+                       if (cmsis_dap_serial != NULL) {
+                               if (wcscmp(cmsis_dap_serial, cur_dev->serial_number) == 0)
+                                       break;
+                       } else
+                               break;
                }
 
                cur_dev = cur_dev->next;
@@ -205,6 +220,11 @@ static int cmsis_dap_usb_open(void)
 
        hid_free_enumeration(devs);
 
+       if (target_vid == 0 && target_pid == 0) {
+               LOG_ERROR("unable to find CMSIS-DAP device");
+               return ERROR_FAIL;
+       }
+
        if (hid_init() != 0) {
                LOG_ERROR("unable to open HIDAPI");
                return ERROR_FAIL;
@@ -264,6 +284,11 @@ static void cmsis_dap_usb_close(struct cmsis_dap *dap)
                cmsis_dap_handle = NULL;
        }
 
+       if (cmsis_dap_serial) {
+               free(cmsis_dap_serial);
+               cmsis_dap_serial = NULL;
+       }
+
        return;
 }
 
@@ -718,11 +743,50 @@ static int cmsis_dap_reset_link(void)
        return retval;
 }
 
+static int cmsis_dap_swd_open(void)
+{
+       int retval;
+
+       DEBUG_IO("CMSIS-DAP: cmsis_dap_swd_open");
+
+       if (cmsis_dap_handle == NULL) {
+
+               /* SWD init */
+               retval = cmsis_dap_usb_open();
+               if (retval != ERROR_OK)
+                       return retval;
+
+               retval = cmsis_dap_get_caps_info();
+               if (retval != ERROR_OK)
+                       return retval;
+       }
+
+       if (!(cmsis_dap_handle->caps & INFO_CAPS_SWD)) {
+               LOG_ERROR("CMSIS-DAP: SWD not supported");
+               return ERROR_JTAG_DEVICE_ERROR;
+       }
+
+       retval = cmsis_dap_cmd_DAP_Connect(CONNECT_SWD);
+       if (retval != ERROR_OK)
+               return retval;
+
+       /* Add more setup here.??... */
+
+       LOG_INFO("CMSIS-DAP: Interface Initialised (SWD)");
+       return ERROR_OK;
+}
+
 static int cmsis_dap_init(void)
 {
        int retval;
        uint8_t *data;
 
+       if (swd_mode) {
+               retval = cmsis_dap_swd_open();
+               if (retval != ERROR_OK)
+                       return retval;
+       }
+
        if (cmsis_dap_handle == NULL) {
 
                /* JTAG init */
@@ -828,36 +892,9 @@ static int cmsis_dap_init(void)
        return ERROR_OK;
 }
 
-static int cmsis_dap_swd_init(uint8_t trn)
+static int cmsis_dap_swd_init(void)
 {
-       int retval;
-
-       DEBUG_IO("CMSIS-DAP: cmsis_dap_swd_init");
-
-       if (cmsis_dap_handle == NULL) {
-
-               /* SWD init */
-               retval = cmsis_dap_usb_open();
-               if (retval != ERROR_OK)
-                       return retval;
-
-               retval = cmsis_dap_get_caps_info();
-               if (retval != ERROR_OK)
-                       return retval;
-       }
-
-       if (!(cmsis_dap_handle->caps & INFO_CAPS_SWD)) {
-               LOG_ERROR("CMSIS-DAP: SWD not supported");
-               return ERROR_JTAG_DEVICE_ERROR;
-       }
-
-       retval = cmsis_dap_cmd_DAP_Connect(CONNECT_SWD);
-       if (retval != ERROR_OK)
-               return retval;
-
-       /* Add more setup here.??... */
-
-       LOG_INFO("CMSIS-DAP: Interface Initialised (SWD)");
+       swd_mode = true;
        return ERROR_OK;
 }
 
@@ -980,6 +1017,27 @@ COMMAND_HANDLER(cmsis_dap_handle_vid_pid_command)
        return ERROR_OK;
 }
 
+COMMAND_HANDLER(cmsis_dap_handle_serial_command)
+{
+       if (CMD_ARGC == 1) {
+               size_t len = mbstowcs(NULL, CMD_ARGV[0], 0);
+               cmsis_dap_serial = calloc(len + 1, sizeof(wchar_t));
+               if (cmsis_dap_serial == NULL) {
+                       LOG_ERROR("unable to allocate memory");
+                       return ERROR_OK;
+               }
+               if (mbstowcs(cmsis_dap_serial, CMD_ARGV[0], len + 1) == (size_t)-1) {
+                       free(cmsis_dap_serial);
+                       cmsis_dap_serial = NULL;
+                       LOG_ERROR("unable to convert serial");
+               }
+       } else {
+               LOG_ERROR("expected exactly one argument to cmsis_dap_serial <serial-number>");
+       }
+
+       return ERROR_OK;
+}
+
 static const struct command_registration cmsis_dap_subcommand_handlers[] = {
        {
                .name = "info",
@@ -1006,6 +1064,13 @@ static const struct command_registration cmsis_dap_command_handlers[] = {
                .help = "the vendor ID and product ID of the CMSIS-DAP device",
                .usage = "(vid pid)* ",
        },
+       {
+               .name = "cmsis_dap_serial",
+               .handler = &cmsis_dap_handle_serial_command,
+               .mode = COMMAND_CONFIG,
+               .help = "set the serial number of the adapter",
+               .usage = "serial_string",
+       },
        COMMAND_REGISTRATION_DONE
 };
 

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)