<p>laforge <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/simtrace2/+/15066">View Change</a></p><div style="white-space:pre-wrap">Approvals:
laforge: Looks good to me, approved
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add serial and version information in USB descriptor<br><br>the device ID (unique to the micro-controller) is now displayed in<br>the USB iSerial descriptor.<br>the git version is now also displayed in iConfiguration in an<br>additional (empty) configuration descriptor.<br>this allows the user to quickly get the device hardware serial and<br>firmware version just by using lsusb (no need for a custom USB<br>software).<br><br>Change-Id: If9fadecc097ca3e006990160936bf11b22eae4e0<br>---<br>M firmware/libcommon/include/simtrace.h<br>M firmware/libcommon/source/usb.c<br>2 files changed, 109 insertions(+), 5 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/firmware/libcommon/include/simtrace.h b/firmware/libcommon/include/simtrace.h</span><br><span>index 0486581..67f3988 100644</span><br><span>--- a/firmware/libcommon/include/simtrace.h</span><br><span>+++ b/firmware/libcommon/include/simtrace.h</span><br><span>@@ -1,6 +1,7 @@</span><br><span> /* SIMtrace 2 mode definitions</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * (C) 2015-2017 by Harald Welte <hwelte@hmw-consulting.de></span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (c) 2015-2017 by Harald Welte <hwelte@hmw-consulting.de></span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (c) 2018-2019, sysmocom -s.f.m.c. GmbH, Author: Kevin Redon <kredon@sysmocom.de></span><br><span> *</span><br><span> * This program is free software; you can redistribute it and/or modify</span><br><span> * it under the terms of the GNU General Public License as published by</span><br><span>@@ -57,6 +58,7 @@</span><br><span> #ifdef HAVE_MITM</span><br><span> CFG_NUM_MITM,</span><br><span> #endif</span><br><span style="color: hsl(120, 100%, 40%);">+ CFG_NUM_VERSION,</span><br><span> NUM_CONF</span><br><span> };</span><br><span> </span><br><span>diff --git a/firmware/libcommon/source/usb.c b/firmware/libcommon/source/usb.c</span><br><span>index 43c7bb2..3efb9fc 100644</span><br><span>--- a/firmware/libcommon/source/usb.c</span><br><span>+++ b/firmware/libcommon/source/usb.c</span><br><span>@@ -2,7 +2,7 @@</span><br><span> * ATMEL Microcontroller Software Support</span><br><span> * ----------------------------------------------------------------------------</span><br><span> * Copyright (c) 2009, Atmel Corporation</span><br><span style="color: hsl(0, 100%, 40%);">- * Copyright (c) 2018, sysmocom -s.f.m.c. GmbH, Author: Kevin Redon <kredon@sysmocom.de></span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (c) 2018-2019, sysmocom -s.f.m.c. GmbH, Author: Kevin Redon <kredon@sysmocom.de></span><br><span> *</span><br><span> * All rights reserved.</span><br><span> *</span><br><span>@@ -46,7 +46,10 @@</span><br><span> * USB String descriptors </span><br><span> *------------------------------------------------------------------------------*/</span><br><span> #include "usb_strings_generated.h"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+// the index of the strings (must match the order in usb_strings.txt)</span><br><span> enum strDescNum {</span><br><span style="color: hsl(120, 100%, 40%);">+ // static strings from usb_strings</span><br><span> MANUF_STR = 1,</span><br><span> PRODUCT_STRING,</span><br><span> SNIFFER_CONF_STR,</span><br><span>@@ -55,9 +58,61 @@</span><br><span> MITM_CONF_STR,</span><br><span> CARDEM_USIM1_INTF_STR,</span><br><span> CARDEM_USIM2_INTF_STR,</span><br><span style="color: hsl(120, 100%, 40%);">+ CARDEM_USIM3_INTF_STR,</span><br><span style="color: hsl(120, 100%, 40%);">+ CARDEM_USIM4_INTF_STR,</span><br><span style="color: hsl(120, 100%, 40%);">+ // runtime strings</span><br><span style="color: hsl(120, 100%, 40%);">+ SERIAL_STR,</span><br><span style="color: hsl(120, 100%, 40%);">+ VERSION_STR,</span><br><span style="color: hsl(120, 100%, 40%);">+ // count</span><br><span> STRING_DESC_CNT</span><br><span> };</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/** array of static (from usb_strings) and runtime (serial, version) USB strings</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static const unsigned char *usb_strings_extended[ARRAY_SIZE(usb_strings) + 2];</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* USB string for the serial (using 128-bit device ID) */</span><br><span style="color: hsl(120, 100%, 40%);">+static unsigned char usb_string_serial[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_LENGTH(32),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBGenericDescriptor_STRING,</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('0'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('0'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('1'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('1'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('2'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('2'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('3'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('3'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('4'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('4'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('5'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('5'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('6'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('6'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('7'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('7'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('8'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('8'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('9'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('9'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('a'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('a'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('b'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('b'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('c'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('c'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('d'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('d'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('e'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('e'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('f'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('f'),</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* USB string for the version */</span><br><span style="color: hsl(120, 100%, 40%);">+static const char git_version[] = GIT_VERSION;</span><br><span style="color: hsl(120, 100%, 40%);">+static unsigned char usb_string_version[2 + ARRAY_SIZE(git_version) * 2 - 2];</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*------------------------------------------------------------------------------</span><br><span> * USB Device descriptors </span><br><span> *------------------------------------------------------------------------------*/</span><br><span>@@ -523,6 +578,27 @@</span><br><span> };</span><br><span> #endif /* HAVE_CARDEM */</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/* USB descriptor just to show the version */</span><br><span style="color: hsl(120, 100%, 40%);">+typedef struct _SIMTraceDriverConfigurationDescriptorVersion {</span><br><span style="color: hsl(120, 100%, 40%);">+ /** Standard configuration descriptor. */</span><br><span style="color: hsl(120, 100%, 40%);">+ USBConfigurationDescriptor configuration;</span><br><span style="color: hsl(120, 100%, 40%);">+} __attribute__ ((packed)) SIMTraceDriverConfigurationDescriptorVersion;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static const SIMTraceDriverConfigurationDescriptorVersion</span><br><span style="color: hsl(120, 100%, 40%);">+ configurationDescriptorVersion = {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Standard configuration descriptor */</span><br><span style="color: hsl(120, 100%, 40%);">+ .configuration = {</span><br><span style="color: hsl(120, 100%, 40%);">+ .bLength = sizeof(USBConfigurationDescriptor),</span><br><span style="color: hsl(120, 100%, 40%);">+ .bDescriptorType = USBGenericDescriptor_CONFIGURATION,</span><br><span style="color: hsl(120, 100%, 40%);">+ .wTotalLength = sizeof(SIMTraceDriverConfigurationDescriptorVersion),</span><br><span style="color: hsl(120, 100%, 40%);">+ .bNumInterfaces = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bConfigurationValue = CFG_NUM_VERSION,</span><br><span style="color: hsl(120, 100%, 40%);">+ .iConfiguration = VERSION_STR,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bmAttributes = USBD_BMATTRIBUTES,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bMaxPower = USBConfigurationDescriptor_POWER(100),</span><br><span style="color: hsl(120, 100%, 40%);">+ },</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> const USBConfigurationDescriptor *configurationDescriptorsArr[] = {</span><br><span> #ifdef HAVE_SNIFFER</span><br><span> &configurationDescriptorSniffer.configuration,</span><br><span>@@ -536,6 +612,7 @@</span><br><span> #ifdef HAVE_MITM</span><br><span> &configurationDescriptorMITM.configuration,</span><br><span> #endif</span><br><span style="color: hsl(120, 100%, 40%);">+ &configurationDescriptorVersion.configuration,</span><br><span> };</span><br><span> </span><br><span> /** Standard USB device descriptor for the CDC serial driver */</span><br><span>@@ -552,7 +629,7 @@</span><br><span> .bcdDevice = 2, /* Release number */</span><br><span> .iManufacturer = MANUF_STR,</span><br><span> .iProduct = PRODUCT_STRING,</span><br><span style="color: hsl(0, 100%, 40%);">- .iSerialNumber = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ .iSerialNumber = SERIAL_STR,</span><br><span> .bNumConfigurations = ARRAY_SIZE(configurationDescriptorsArr),</span><br><span> };</span><br><span> </span><br><span>@@ -566,8 +643,8 @@</span><br><span> 0, /* No high-speed configuration descriptor */</span><br><span> 0, /* No high-speed device qualifier descriptor */</span><br><span> 0, /* No high-speed other speed configuration descriptor */</span><br><span style="color: hsl(0, 100%, 40%);">- usb_strings,</span><br><span style="color: hsl(0, 100%, 40%);">- ARRAY_SIZE(usb_strings),/* cnt string descriptors in list */</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_strings_extended,</span><br><span style="color: hsl(120, 100%, 40%);">+ ARRAY_SIZE(usb_strings_extended),/* cnt string descriptors in list */</span><br><span> };</span><br><span> </span><br><span> /*----------------------------------------------------------------------------</span><br><span>@@ -593,6 +670,31 @@</span><br><span> // Get std USB driver</span><br><span> USBDDriver *pUsbd = USBD_GetDriver();</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ // put device ID into USB serial number description</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int device_id[4];</span><br><span style="color: hsl(120, 100%, 40%);">+ EEFC_ReadUniqueID(device_id);</span><br><span style="color: hsl(120, 100%, 40%);">+ char device_id_string[32 + 1];</span><br><span style="color: hsl(120, 100%, 40%);">+ snprintf(device_id_string, ARRAY_SIZE(device_id_string), "%08x%08x%08x%08x",</span><br><span style="color: hsl(120, 100%, 40%);">+ device_id[0], device_id[1], device_id[2], device_id[3]);</span><br><span style="color: hsl(120, 100%, 40%);">+ for (uint8_t i = 0; i < ARRAY_SIZE(device_id_string) - 1; i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_string_serial[2 + 2 * i] = device_id_string[i];</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ // put version into USB string</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_string_version[0] = USBStringDescriptor_LENGTH(ARRAY_SIZE(git_version) - 1);</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_string_version[1] = USBGenericDescriptor_STRING;</span><br><span style="color: hsl(120, 100%, 40%);">+ for (uint8_t i = 0; i < ARRAY_SIZE(git_version) - 1; i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_string_version[2 + i * 2 + 0] = git_version[i];</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_string_version[2 + i * 2 + 1] = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ // fill extended USB strings</span><br><span style="color: hsl(120, 100%, 40%);">+ for (uint8_t i = 0; i < ARRAY_SIZE(usb_strings) && i < ARRAY_SIZE(usb_strings_extended); i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_strings_extended[i] = usb_strings[i];</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_strings_extended[SERIAL_STR] = usb_string_serial;</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_strings_extended[VERSION_STR] = usb_string_version;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> // Initialize standard USB driver</span><br><span> USBDDriver_Initialize(pUsbd, &driverDescriptors, 0); // Multiple interface settings not supported</span><br><span> USBD_Init();</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/simtrace2/+/15066">change 15066</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/simtrace2/+/15066"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: simtrace2 </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: If9fadecc097ca3e006990160936bf11b22eae4e0 </div>
<div style="display:none"> Gerrit-Change-Number: 15066 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: tsaitgaist <kredon@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>