<p>tsaitgaist has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/simtrace2/+/16095">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add serial and version info in USB description<br><br>as for the main application firmware, the DFU bootloader firmware<br>now also has the unique chip ID as iSerial in the USB description,<br>and an additional empty USB configuration indicates the firmware<br>version (e.g. DFU bootloader version).<br>these are only visible when the device is in DFU mode.<br><br>Change-Id: I11a2cd8079fda374d816da180f39f1c33d10af60<br>---<br>M firmware/atmel_softpack_libraries/usb/device/dfu/dfu.h<br>M firmware/atmel_softpack_libraries/usb/device/dfu/dfu_desc.c<br>M firmware/atmel_softpack_libraries/usb/device/dfu/dfu_driver.c<br>3 files changed, 141 insertions(+), 14 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/simtrace2 refs/changes/95/16095/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/firmware/atmel_softpack_libraries/usb/device/dfu/dfu.h b/firmware/atmel_softpack_libraries/usb/device/dfu/dfu.h</span><br><span>index 2a44602..7354696 100644</span><br><span>--- a/firmware/atmel_softpack_libraries/usb/device/dfu/dfu.h</span><br><span>+++ b/firmware/atmel_softpack_libraries/usb/device/dfu/dfu.h</span><br><span>@@ -101,7 +101,7 @@</span><br><span> extern struct dfudata _g_dfu;</span><br><span> extern struct dfudata *g_dfu;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-void set_usb_serial_str(const uint8_t *serial_usbstr);</span><br><span style="color: hsl(120, 100%, 40%);">+void set_usb_serial_str(void);</span><br><span> </span><br><span> void DFURT_SwitchToDFU(void);</span><br><span> </span><br><span>diff --git a/firmware/atmel_softpack_libraries/usb/device/dfu/dfu_desc.c b/firmware/atmel_softpack_libraries/usb/device/dfu/dfu_desc.c</span><br><span>index 75fded1..ebbe070 100644</span><br><span>--- a/firmware/atmel_softpack_libraries/usb/device/dfu/dfu_desc.c</span><br><span>+++ b/firmware/atmel_softpack_libraries/usb/device/dfu/dfu_desc.c</span><br><span>@@ -13,14 +13,87 @@</span><br><span> #include <usb/common/dfu/usb_dfu.h></span><br><span> #include <usb/device/dfu/dfu.h></span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+#include "usb_strings_generated.h"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> enum {</span><br><span> STR_MANUF = 1,</span><br><span> STR_PROD,</span><br><span> STR_CONFIG,</span><br><span> _STR_FIRST_ALT,</span><br><span style="color: hsl(120, 100%, 40%);">+ // serial string</span><br><span> STR_SERIAL = (_STR_FIRST_ALT+BOARD_DFU_NUM_IF),</span><br><span style="color: hsl(120, 100%, 40%);">+ // version string (on additional interface)</span><br><span style="color: hsl(120, 100%, 40%);">+ VERSION_CONF_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 style="color: hsl(120, 100%, 40%);">+ STRING_DESC_CNT,</span><br><span> };</span><br><span> </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 unsigned char usb_string_version_conf[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_LENGTH(16),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBGenericDescriptor_STRING,</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('f'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('i'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('r'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('m'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('w'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('a'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('r'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('e'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE(' '),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('v'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('e'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('r'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('s'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('i'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('o'),</span><br><span style="color: hsl(120, 100%, 40%);">+ USBStringDescriptor_UNICODE('n'),</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%);">+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%);">+/** array of static (from usb_strings) and runtime (serial, version) USB strings */</span><br><span style="color: hsl(120, 100%, 40%);">+static const unsigned char *usb_strings_extended[STRING_DESC_CNT];</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> static const USBDeviceDescriptor fsDevice = {</span><br><span> .bLength = sizeof(USBDeviceDescriptor),</span><br><span> .bDescriptorType = USBGenericDescriptor_DEVICE,</span><br><span>@@ -34,12 +107,8 @@</span><br><span> .bcdDevice = BOARD_USB_RELEASE,</span><br><span> .iManufacturer = STR_MANUF,</span><br><span> .iProduct = STR_PROD,</span><br><span style="color: hsl(0, 100%, 40%);">-#ifdef BOARD_USB_SERIAL</span><br><span> .iSerialNumber = STR_SERIAL,</span><br><span style="color: hsl(0, 100%, 40%);">-#else</span><br><span style="color: hsl(0, 100%, 40%);">- .iSerialNumber = 0,</span><br><span style="color: hsl(0, 100%, 40%);">-#endif</span><br><span style="color: hsl(0, 100%, 40%);">- .bNumConfigurations = 1,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bNumConfigurations = 2, // DFU + version configurations</span><br><span> };</span><br><span> </span><br><span> /* Alternate Interface Descriptor, we use one per partition/memory type */</span><br><span>@@ -85,17 +154,74 @@</span><br><span> .func_dfu = DFU_FUNC_DESC</span><br><span> };</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-#include "usb_strings_generated.h"</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-#if 0</span><br><span style="color: hsl(0, 100%, 40%);">-void set_usb_serial_str(const uint8_t *serial_usbstr)</span><br><span style="color: hsl(120, 100%, 40%);">+void set_usb_serial_str(void)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- usb_strings[STR_SERIAL] = serial_usbstr;</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int i;</span><br><span style="color: hsl(120, 100%, 40%);">+</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 (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 (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 (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[STR_SERIAL] = usb_string_serial;</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_strings_extended[VERSION_CONF_STR] = usb_string_version_conf;</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_strings_extended[VERSION_STR] = usb_string_version;</span><br><span> }</span><br><span style="color: hsl(0, 100%, 40%);">-#endif</span><br><span style="color: hsl(120, 100%, 40%);">+</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%);">+ USBInterfaceDescriptor version;</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 for the interface 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 = 1,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bConfigurationValue = 2,</span><br><span style="color: hsl(120, 100%, 40%);">+ .iConfiguration = VERSION_CONF_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%);">+ /* Interface standard descriptor just holding the version information */</span><br><span style="color: hsl(120, 100%, 40%);">+ .version = {</span><br><span style="color: hsl(120, 100%, 40%);">+ .bLength = sizeof(USBInterfaceDescriptor),</span><br><span style="color: hsl(120, 100%, 40%);">+ .bDescriptorType = USBGenericDescriptor_INTERFACE,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bInterfaceNumber = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bAlternateSetting = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bNumEndpoints = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bInterfaceClass = USB_CLASS_PROPRIETARY,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bInterfaceSubClass = 0xff,</span><br><span style="color: hsl(120, 100%, 40%);">+ .bInterfaceProtocol = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ .iInterface = VERSION_STR,</span><br><span style="color: hsl(120, 100%, 40%);">+ },</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span> </span><br><span> static const USBConfigurationDescriptor *conf_desc_arr[] = {</span><br><span> &dfu_cfg_descriptor.ucfg,</span><br><span style="color: hsl(120, 100%, 40%);">+ &configurationDescriptorVersion.configuration,</span><br><span> };</span><br><span> </span><br><span> const USBDDriverDescriptors dfu_descriptors = {</span><br><span>@@ -108,6 +234,6 @@</span><br><span> .pHsConfiguration = NULL,</span><br><span> .pHsQualifier = NULL,</span><br><span> .pHsOtherSpeed = NULL,</span><br><span style="color: hsl(0, 100%, 40%);">- .pStrings = usb_strings,</span><br><span style="color: hsl(0, 100%, 40%);">- .numStrings = ARRAY_SIZE(usb_strings),</span><br><span style="color: hsl(120, 100%, 40%);">+ .pStrings = usb_strings_extended,</span><br><span style="color: hsl(120, 100%, 40%);">+ .numStrings = ARRAY_SIZE(usb_strings_extended),</span><br><span> };</span><br><span>diff --git a/firmware/atmel_softpack_libraries/usb/device/dfu/dfu_driver.c b/firmware/atmel_softpack_libraries/usb/device/dfu/dfu_driver.c</span><br><span>index 6230d6c..3ffd9b3 100644</span><br><span>--- a/firmware/atmel_softpack_libraries/usb/device/dfu/dfu_driver.c</span><br><span>+++ b/firmware/atmel_softpack_libraries/usb/device/dfu/dfu_driver.c</span><br><span>@@ -447,6 +447,7 @@</span><br><span> /* We already start in DFU idle mode */</span><br><span> g_dfu->state = DFU_STATE_dfuIDLE;</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ set_usb_serial_str();</span><br><span> USBDDriver_Initialize(&usbdDriver, pDescriptors, if_altsettings);</span><br><span> USBD_Init();</span><br><span> USBD_Connect();</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/simtrace2/+/16095">change 16095</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/+/16095"/><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: I11a2cd8079fda374d816da180f39f1c33d10af60 </div>
<div style="display:none"> Gerrit-Change-Number: 16095 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: tsaitgaist <kredon@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>