cmsis_dap: Send correct version string when queried.

zyp · zyp · commit ad6dfc8cf835 · 2023-06-21T01:02:51.000+02:00
diff --git a/orbtrace/debug/cmsis_dap.py b/orbtrace/debug/cmsis_dap.py
@@ -1,5 +1,6 @@
 from amaranth                import *
 from .dbgIF                  import DBGIF
+from ..git_version           import get_version
 
 # Principle of operation
 # ======================
@@ -19,8 +20,8 @@
 DAP_CONNECT_DEFAULT      = 1                # Default connect is SWD
 DAP_PROTOCOL_STRING_LEN  = 5
 DAP_PROTOCOL_STRING      = Cat(C(DAP_PROTOCOL_STRING_LEN+1,8),C(ord('2'),8),C(ord('.'),8),C(ord('1'),8),C(ord('.'),8),C(ord('0'),8),C(0,8)) # Protocol version V2.1.0
-DAP_VERSION_STRING_LEN   = 4
-DAP_VERSION_STRING       = Cat(C(DAP_VERSION_STRING_LEN+1,8),C(0x31,8),C(0x2e,8),C(0x30,8),C(0x30,8),C(0,8))
+DAP_VERSION_STRING_LEN   = len(get_version().encode('utf-8'))
+DAP_VERSION_STRING       = Cat(C(DAP_VERSION_STRING_LEN+1,8), *(C(c, 8) for c in get_version().encode('utf-8')), C(0,8))
 DAP_CAPABILITIES         = 0x03             # JTAG and SWD Debug
 DAP_TD_TIMER_FREQ        = 0x3B9ACA00       # 1uS resolution timer
 DAP_MAX_PACKET_COUNT     = 1                # 1 max packet count
@@ -164,7 +165,7 @@ def __init__(self, streamIn, streamOut, dbgif, v2Indication):
         self.rxedLen        = Signal(3)      # Rxlen picked up so far
 
         # Transmit block construction
-        self.txBlock        = Signal( 14*8 ) # Response to be returned
+        self.txBlock        = Signal( 32*8 ) # Response to be returned
         self.txLen          = Signal(range(MAX_MSG_LEN))     # Length of response to be returned
         self.txedLen        = Signal(range(MAX_MSG_LEN))     # Length of response that has been returned so far
         self.busy           = Signal()       # Indicator that we can't receive stream traffic at the moment
diff --git a/orbtrace/git_version.py b/orbtrace/git_version.py
@@ -0,0 +1,17 @@
+import functools
+import subprocess
+import re
+
+@functools.cache
+def get_version():
+    return subprocess.check_output('git describe --always --long --dirty', shell = True).decode('utf-8').strip()
+
+def get_version_bcd():
+    m = re.match(r'v(\d{1,2})\.(\d)(?:\.(\d+))?-', get_version())
+
+    if not m:
+        raise ValueError('Version doesn\'t match pattern representable as BCD')
+
+    major, minor, patch = m.groups()
+
+    return int(major) + int(minor) * 0.1 + int(patch or 0) * 0.01
diff --git a/orbtrace/soc.py b/orbtrace/soc.py
@@ -1,4 +1,3 @@
-import subprocess
 import uuid
 
 from orbtrace.usb_serialnumber import USBSerialNumberHandler
@@ -31,6 +30,8 @@
 
 from .reset import Reset
 
+from .git_version import get_version, get_version_bcd
+
 from usb_protocol.types      import USBTransferType, USBRequestType, USBStandardRequests, USBRequestRecipient, DescriptorTypes
 from usb_protocol.emitters.descriptors import cdc
 
@@ -767,16 +768,14 @@ def add_usb_version(self):
         # USB interface.
         if_num = self.usb_alloc.interface(guid_discriminator=0x00_56)
 
-        version = subprocess.check_output('git describe --always --long --dirty', shell = True).decode('utf-8').strip()
-
         # USB descriptors.
         with self.usb_conf_desc.InterfaceDescriptor() as i:
             i.bInterfaceNumber   = if_num
             i.bInterfaceClass    = 0xff
             i.bInterfaceSubclass = 0x56
             i.bInterfaceProtocol = 0x00
 
-            i.iInterface = f'Version: {version}'
+            i.iInterface = f'Version: {get_version()}'
 
     def add_usb_control_handler(self, handler):
         if hasattr(self, 'usb_control_ep'):
@@ -798,7 +797,7 @@ def add_usb(self, vid, pid):
             d.idVendor           = vid
             d.idProduct          = pid
             d.bcdUSB             = 2.1 # Support BOS descriptors
-            d.bcdDevice          = 1.2
+            d.bcdDevice          = get_version_bcd()
 
             d.iManufacturer      = "Orbcode"
             d.iProduct           = "Orbtrace Bootloader" if pid == 0x3442 else "Orbtrace Test" if pid == 0x0001 else "Orbtrace"
