Merge pull request #1077 from flit/bugfix/probe_none_serial

CMSIS-DAP: handle pyusb returning None for USB serial number

pyocd/probe/pydapaccess/interface/common.py

@@ -1,5 +1,6 @@
 # pyOCD debugger
-# Copyright (c) 2019-2020 Arm Limited
+# Copyright (c) 2019-2021 Arm Limited
+# Copyright (c) 2021 mentha
 # SPDX-License-Identifier: Apache-2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,6 +16,8 @@
 # limitations under the License.
 
 import usb.util
+from hashlib import sha1
+from base64 import b32encode
 
 # USB class codes.
 USB_CLASS_COMPOSITE = 0x00
@@ -106,3 +109,18 @@ def check_ep(interface, ep_index, ep_dir, ep_type):
     ep = interface[ep_index]
     return (usb.util.endpoint_direction(ep.bEndpointAddress) == ep_dir) \
         and (usb.util.endpoint_type(ep.bmAttributes) == ep_type)
+
+def generate_device_unique_id(dev):
+    """! @brief Generate a semi-stable unique ID from a pyusb device.
+    
+    This function is intended to be used in cases where a device does not provide a serial number
+    string. pyocd still needs a valid unique ID so the device can be selected from amongst multiple
+    connected devices. The algorithm used here generates an ID that is stable for a given device as
+    long as it is connected to the same USB port.
+    
+    @param dev pyusb device object.
+    @return 16-character string.
+    """
+    s = "{:4x},{:4x},{:s},{:s}".format(dev.idProduct, dev.idVendor, dev.bus, dev.address)
+    return b32encode(sha1(s.encode()).digest()).decode('ascii')[:16]
+

pyocd/probe/pydapaccess/interface/pyusb_backend.py

@@ -1,6 +1,7 @@
 # pyOCD debugger
-# Copyright (c) 2006-2020 Arm Limited
+# Copyright (c) 2006-2021 Arm Limited
 # Copyright (c) 2020 Patrick Huesmann
+# Copyright (c) 2021 mentha
 # SPDX-License-Identifier: Apache-2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,6 +29,7 @@
     filter_device_by_class,
     is_known_cmsis_dap_vid_pid,
     check_ep,
+    generate_device_unique_id,
     )
 from ..dap_access_api import DAPAccessIntf
 
@@ -167,9 +169,9 @@ def get_all_connected_interfaces():
             new_board = PyUSB()
             new_board.vid = board.idVendor
             new_board.pid = board.idProduct
-            new_board.product_name = board.product
-            new_board.vendor_name = board.manufacturer
-            new_board.serial_number = board.serial_number
+            new_board.product_name = board.product or hex(board.idProduct)
+            new_board.vendor_name = board.manufacturer or hex(board.idVendor)
+            new_board.serial_number = board.serial_number or generate_device_unique_id(board)
             boards.append(new_board)
 
         return boards
@@ -354,6 +356,8 @@ def __call__(self, dev):
         if cmsis_dap_interface is None:
             return False
         if self._serial is not None:
+            if self._serial == "" and dev.serial_number is None:
+                return True
             if self._serial != dev.serial_number:
                 return False
         return True

pyocd/probe/pydapaccess/interface/pyusb_v2_backend.py

@@ -1,5 +1,6 @@
 # pyOCD debugger
-# Copyright (c) 2019-2020 Arm Limited
+# Copyright (c) 2019-2021 Arm Limited
+# Copyright (c) 2021 mentha
 # SPDX-License-Identifier: Apache-2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,6 +28,7 @@
     filter_device_by_class,
     is_known_cmsis_dap_vid_pid,
     check_ep,
+    generate_device_unique_id,
     )
 from ..dap_access_api import DAPAccessIntf
 from ... import common
@@ -185,9 +187,9 @@ def get_all_connected_interfaces():
             new_board = PyUSBv2()
             new_board.vid = board.idVendor
             new_board.pid = board.idProduct
-            new_board.product_name = board.product
-            new_board.vendor_name = board.manufacturer
-            new_board.serial_number = board.serial_number
+            new_board.product_name = board.product or hex(board.idProduct)
+            new_board.vendor_name = board.manufacturer or hex(board.idVendor)
+            new_board.serial_number = board.serial_number or generate_device_unique_id(board)
             boards.append(new_board)
 
         return boards
@@ -336,6 +338,8 @@ def __call__(self, dev):
             return False
 
         if self._serial is not None:
+            if self._serial == "" and dev.serial_number is None:
+                return True
             if self._serial != dev.serial_number:
                 return False
         return True

test/probeserver_test.py

@@ -78,7 +78,7 @@ def run(self, board):
         try:
             result = self.test_function(board.unique_id, self.n)
         except Exception as e:
-            result = GdbTestResult()
+            result = ProbeserverTestResult()
             result.passed = False
             print("Exception %s when testing board %s" %
                   (e, board.unique_id))