create HID report protocol compatibility tester application

Author: benedekkupper

.vscode/tasks.json

@@ -126,6 +126,29 @@
             "problemMatcher": [
                 "$gcc"
             ]
+        },
+        {
+            "label": "Build hid-rp-compat-tester for nrf52840dk",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "options": {
+                "cwd": "${workspaceFolder}"
+            },
+            "type": "process",
+            "command": "west",
+            "args": [
+                "build",
+                "--build-dir",
+                "${cwd}/hid-rp-compat-tester/build/nrf52840dk",
+                "${cwd}/hid-rp-compat-tester",
+                "--board",
+                "nrf52840dk/nrf52840"
+            ],
+            "problemMatcher": [
+                "$gcc"
+            ]
         }
     ]
 }

README.md

@@ -13,8 +13,7 @@ command:
 west init -m https://github.com/IntergatedCircuits/c2usb-zephyr-examples c2usb-workspace
 # update Zephyr modules
 cd c2usb-workspace
-west update
-west patch
+west update && west patch
 ```
 
 ## Application Index
@@ -26,6 +25,11 @@ A straightforward BLE HID keyboard. UART shell access is needed to complete BLE
 Use the button on the board to trigger a caps lock press,
 and observe as the host changes the caps lock state on the board's LED.
 
+### hid-rp-compat-tester
+
+A device that performs a sequence of USB enumerations, testing whether the host OS is capable
+of interpreting various HID report descriptor variations of an HID keyboard.
+
 ### usb-keyboard
 
 A straightforward USB HID keyboard. Use the button on the board to trigger a caps lock press,

hid-rp-compat-tester/CMakeLists.txt

@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(hid-rp-compat-tester)
+
+target_sources(app PRIVATE src/main.cpp)
+
+# link the application to c2usb
+target_link_libraries(app PRIVATE
+    c2usb
+    c2usb-example-hid
+)

hid-rp-compat-tester/Kconfig

@@ -0,0 +1,2 @@
+source "Kconfig.zephyr"
+rsource "../Kconfig"

hid-rp-compat-tester/prj.conf

@@ -0,0 +1,41 @@
+CONFIG_LOG=y
+CONFIG_UDC_DRIVER_LOG_LEVEL_WRN=y
+#CONFIG_C2USB_UDC_MAC_LOG_LEVEL_DBG=y
+
+CONFIG_INPUT=y
+CONFIG_INPUT_MODE_SYNCHRONOUS=y
+CONFIG_HWINFO=y
+
+CONFIG_SHELL=y
+CONFIG_SHELL_BACKEND_C2USB=y
+# CONFIG_SHELL_BACKEND_SERIAL=y
+CONFIG_SHELL_LOG_BACKEND=y
+CONFIG_SHELL_MINIMAL=n
+# needs to be ~100 bytes more than default
+CONFIG_SHELL_STACK_SIZE=1536
+
+CONFIG_C2USB_UDC_MAC=y
+# RAM optimization:
+# the buffer pool size can be cut down, as it's only used for control transfers
+# CONFIG_UDC_BUF_POOL_SIZE=optimize based on your application (and check asserts)
+# CONFIG_UDC_BUF_COUNT=3 + maximal used endpoint count in a configuration
+
+# needed as at suspend the msgq is flooded otherwise
+# CONFIG_C2USB_UDC_MAC_MSGQ_SIZE=32
+
+CONFIG_DEBUG=y
+CONFIG_DEBUG_OPTIMIZATIONS=y
+CONFIG_DEBUG_THREAD_INFO=y
+
+# don't use picolibc in debug builds as only its module version can print verbose assert() logs
+# CONFIG_PICOLIBC_VERBOSE_ASSERT=y
+# but that's conflicting with the chosen C++ standard library
+CONFIG_NEWLIB_LIBC=y
+
+CONFIG_USE_SEGGER_RTT=n
+
+CONFIG_DEMO_MANUFACTURER="github.com/IntergatedCircuits/c2usb-zephyr-examples"
+CONFIG_DEMO_PRODUCT="HID RP compatibility tester"
+# use reserved VID/PID that won't conflict with real devices, in case of host OS blacklisting
+CONFIG_DEMO_MANUFACTURER_ID=0x335e
+CONFIG_DEMO_PRODUCT_ID=0x1cff

hid-rp-compat-tester/sample.yaml

@@ -0,0 +1,9 @@
+sample:
+  name: HID RP Compatibility Tester
+common:
+  harness: button
+  filter: dt_alias_exists("sw0") and dt_alias_exists("led0")
+  depends_on:
+    - gpio
+  platform_allow:
+    - nrf52840dk/nrf52840