From 36f888f8b586c06400b8a4b816862f00efb2e111 Mon Sep 17 00:00:00 2001
From: Harald Welte <laforge@osmocom.org>
Date: Fri, 6 Dec 2019 19:17:53 +0100
Subject: [PATCH] Patch actual board name into the USB iProduct string
 descriptor

"SIMtrace 2 compatible device" is pretty generic.  Let's have the
actual board name inside the string descriptors, giving a more
user friendly experience in case users are issuing 'lsusb' and the
like.

Change-Id: Ibcc338b504bd2a1605e31d7f5eadb7161f547c6a
---
 firmware/Makefile                               | 7 ++++++-
 firmware/apps/cardem/usb_strings.txt            | 2 +-
 firmware/apps/dfu/usb_strings.txt               | 2 +-
 firmware/apps/freq_ctr/usb_strings.txt          | 2 +-
 firmware/apps/gpio_test/usb_strings.txt         | 2 +-
 firmware/apps/trace/usb_strings.txt             | 2 +-
 firmware/libboard/octsimtest/product_string.txt | 1 +
 firmware/libboard/owhw/product_string.txt       | 1 +
 firmware/libboard/qmod/product_string.txt       | 1 +
 firmware/libboard/simtrace/product_string.txt   | 1 +
 10 files changed, 15 insertions(+), 6 deletions(-)
 create mode 100644 firmware/libboard/octsimtest/product_string.txt
 create mode 100644 firmware/libboard/owhw/product_string.txt
 create mode 100644 firmware/libboard/qmod/product_string.txt
 create mode 100644 firmware/libboard/simtrace/product_string.txt

diff --git a/firmware/Makefile b/firmware/Makefile
index 4318e2d9..a684424a 100644
--- a/firmware/Makefile
+++ b/firmware/Makefile
@@ -195,7 +195,11 @@ $(BIN) $(OBJ):
 usbstring/usbstring: usbstring/usbstring.c
 	gcc $^ -o $@
 
-apps/$(APP)/usb_strings_generated.h: apps/$(APP)/usb_strings.txt usbstring/usbstring
+.PHONY: apps/$(APP)/usb_strings.txt.patched
+apps/$(APP)/usb_strings.txt.patched: apps/$(APP)/usb_strings.txt
+	sed "s/PRODUCT_STRING/$(shell cat libboard/$(BOARD)/product_string.txt)/" $< > $@
+
+apps/$(APP)/usb_strings_generated.h: apps/$(APP)/usb_strings.txt.patched usbstring/usbstring
 	cat $< | usbstring/usbstring > $@
 
 define RULES
@@ -235,6 +239,7 @@ log:
 	lsof $(SERIAL) && echo "log is already opened" || ( sed -u "s/\r//" $(SERIAL) | ts )
 
 clean:
+	-rm -f apps/$(APP)/usb_strings.txt.patched
 	-rm -fR $(OBJ)/*.o $(BIN)/*.bin $(BIN)/*.elf $(BIN)/*.elf.txt $(BIN)/*.map $(BIN)/*.lst `find . -name \*.p`
 
 install:
diff --git a/firmware/apps/cardem/usb_strings.txt b/firmware/apps/cardem/usb_strings.txt
index f0cd24c2..3a1bcc38 100644
--- a/firmware/apps/cardem/usb_strings.txt
+++ b/firmware/apps/cardem/usb_strings.txt
@@ -1,5 +1,5 @@
 sysmocom - s.f.m.c. GmbH
-SIMtrace 2 compatible device
+PRODUCT_STRING
 SIMtrace Sniffer
 SIMtrace CCID
 SIMtrace Card Emulation
diff --git a/firmware/apps/dfu/usb_strings.txt b/firmware/apps/dfu/usb_strings.txt
index 8a4facb2..f1c79bc9 100644
--- a/firmware/apps/dfu/usb_strings.txt
+++ b/firmware/apps/dfu/usb_strings.txt
@@ -1,5 +1,5 @@
 sysmocom - s.f.m.c. GmbH
-SIMtrace 2 compatible device
+PRODUCT_STRING
 DFU (Device Firmware Upgrade)
 RAM
 Flash (Application Partition)
diff --git a/firmware/apps/freq_ctr/usb_strings.txt b/firmware/apps/freq_ctr/usb_strings.txt
index f0cd24c2..3a1bcc38 100644
--- a/firmware/apps/freq_ctr/usb_strings.txt
+++ b/firmware/apps/freq_ctr/usb_strings.txt
@@ -1,5 +1,5 @@
 sysmocom - s.f.m.c. GmbH
-SIMtrace 2 compatible device
+PRODUCT_STRING
 SIMtrace Sniffer
 SIMtrace CCID
 SIMtrace Card Emulation
diff --git a/firmware/apps/gpio_test/usb_strings.txt b/firmware/apps/gpio_test/usb_strings.txt
index f0cd24c2..3a1bcc38 100644
--- a/firmware/apps/gpio_test/usb_strings.txt
+++ b/firmware/apps/gpio_test/usb_strings.txt
@@ -1,5 +1,5 @@
 sysmocom - s.f.m.c. GmbH
-SIMtrace 2 compatible device
+PRODUCT_STRING
 SIMtrace Sniffer
 SIMtrace CCID
 SIMtrace Card Emulation
diff --git a/firmware/apps/trace/usb_strings.txt b/firmware/apps/trace/usb_strings.txt
index f0cd24c2..3a1bcc38 100644
--- a/firmware/apps/trace/usb_strings.txt
+++ b/firmware/apps/trace/usb_strings.txt
@@ -1,5 +1,5 @@
 sysmocom - s.f.m.c. GmbH
-SIMtrace 2 compatible device
+PRODUCT_STRING
 SIMtrace Sniffer
 SIMtrace CCID
 SIMtrace Card Emulation
diff --git a/firmware/libboard/octsimtest/product_string.txt b/firmware/libboard/octsimtest/product_string.txt
new file mode 100644
index 00000000..83cbcf5d
--- /dev/null
+++ b/firmware/libboard/octsimtest/product_string.txt
@@ -0,0 +1 @@
+sysmoOCTSIM-Tester
diff --git a/firmware/libboard/owhw/product_string.txt b/firmware/libboard/owhw/product_string.txt
new file mode 100644
index 00000000..77c3b1be
--- /dev/null
+++ b/firmware/libboard/owhw/product_string.txt
@@ -0,0 +1 @@
+OWHW
diff --git a/firmware/libboard/qmod/product_string.txt b/firmware/libboard/qmod/product_string.txt
new file mode 100644
index 00000000..2407b9dd
--- /dev/null
+++ b/firmware/libboard/qmod/product_string.txt
@@ -0,0 +1 @@
+sysmoQMOD (Quad Modem)
diff --git a/firmware/libboard/simtrace/product_string.txt b/firmware/libboard/simtrace/product_string.txt
new file mode 100644
index 00000000..5634f3a1
--- /dev/null
+++ b/firmware/libboard/simtrace/product_string.txt
@@ -0,0 +1 @@
+SIMtrace 2