Enhanced test devices

Author: manuelbl

java-does-usb/src/test/java/net/codecrete/usb/ControlTransferTest.java

@@ -12,6 +12,7 @@
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
  * Tests control transfers
@@ -38,4 +39,17 @@ void storeValueInDataStage_canBeRetrieved() {
         var retrievedValue = testDevice.controlTransferIn(new USBControlTransfer(USBRequestType.VENDOR, USBRecipient.INTERFACE, (byte) 0x03, (short) 0, (short) interfaceNumber), 4);
         assertArrayEquals(sentValue, retrievedValue);
     }
+
+    @Test
+    void interfaceNumber_canBeRetrieved() {
+        var response = testDevice.controlTransferIn(new USBControlTransfer(USBRequestType.VENDOR, USBRecipient.INTERFACE, (byte) 0x05, (short) 0, (short) interfaceNumber), 1);
+        assertEquals(interfaceNumber, response[0] & 0xff);
+
+        if (isCompositeDevce()) {
+            testDevice.claimInterface(2);
+            response = testDevice.controlTransferIn(new USBControlTransfer(USBRequestType.VENDOR, USBRecipient.INTERFACE, (byte) 0x05, (short) 0, (short) 2), 1);
+            assertEquals(2, response[0] & 0xff);
+            testDevice.releaseInterface(2);
+        }
+    }
 }

java-does-usb/src/test/java/net/codecrete/usb/DescriptionTest.java

@@ -24,16 +24,16 @@ void deviceInfo_isCorrect() {
         assertEquals(isLoopbackDevice() ? "Loopback" : "Composite", testDevice.product());
         assertEquals(12, testDevice.serialNumber().length());
 
-        if (interfaceNumber == 2) {
-            // composite device
-            assertEquals(0xef, testDevice.classCode());
-            assertEquals(0x02, testDevice.subclassCode());
-            assertEquals(0x01, testDevice.protocolCode());
-        } else {
+        if (isLoopbackDevice()) {
             // simple device
             assertEquals(0xff, testDevice.classCode());
             assertEquals(0x00, testDevice.subclassCode());
             assertEquals(0x00, testDevice.protocolCode());
+        } else {
+            // composite device
+            assertEquals(0xef, testDevice.classCode());
+            assertEquals(0x02, testDevice.subclassCode());
+            assertEquals(0x01, testDevice.protocolCode());
         }
 
         var isComposite = isCompositeDevce();
@@ -132,7 +132,7 @@ void endpointDescriptors_areCorrect() {
 
     @Test
     void configurationDescription_isAvailable() {
-        var expectedLength = isLoopbackDevice() ? 69 : 98;
+        var expectedLength = isLoopbackDevice() ? 69 : 115;
 
         var configDesc = testDevice.configurationDescriptor();
         assertNotNull(configDesc);

java-does-usb/src/test/java/net/codecrete/usb/TestDeviceBase.java

@@ -41,7 +41,7 @@ public class TestDeviceBase {
     /**
      * Composite test device loopback interface number
      */
-    static final int LOOPBACK_INTF_COMPOSITE = 2;
+    static final int LOOPBACK_INTF_COMPOSITE = 3;
     /**
      * Interface number of connected test device
      */

test-devices/composite-stm32/bin/blackpill-f401cc.bin

@@ -2,7 +2,9 @@
 tinyusb_flags = 
     -D CFG_TUD_CDC=1
     -D CFG_VENDOR_ADVANCED=1
+    -D CFG_VENDOR_ADVANCED_NUM_INTF=2
     -D CFG_TUSB_RHPORT1_MODE=OPT_MODE_NONE
+    -D CFG_WINUSB=OPT_WINUSB_MSOS20
 platform = ststm32
 framework = cmsis
 debug_tool = stlink

test-devices/composite-stm32/bin/blackpill-f411ce.bin

@@ -157,6 +157,12 @@ void cust_vendor_halt_cleared_cb(uint8_t ep_addr) {
 
 // --- Control messages (see README)
 
+#define REQUEST_SAVE_VALUE 0x01
+#define REQUEST_SAVE_DATA 0x02
+#define REQUEST_SEND_DATA 0x03
+#define REQUEST_RESET_BUFFERS 0x04
+#define REQUEST_GET_INTF_NUM 0x05
+
 static uint32_t saved_value = 0;
 
 bool tud_vendor_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request) {
@@ -168,35 +174,46 @@ bool tud_vendor_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_requ
 
         switch (request->bRequest) {
 
-        case 0x01:
+        case REQUEST_SAVE_VALUE:
             if (request->bmRequestType_bit.direction == TUSB_DIR_OUT && request->wLength == 0) {
                 // save value from wValue
                 saved_value = request->wValue;
                 return tud_control_status(rhport, request);
             }
             break;
 
-        case 0x02:
+        case REQUEST_SAVE_DATA:
             if (request->bmRequestType_bit.direction == TUSB_DIR_OUT && request->wLength == 4) {
                 // receive into `saved_value`
                 return tud_control_xfer(rhport, request, &saved_value, 4);
             }
             break;
 
-        case 0x03:
+        case REQUEST_SEND_DATA:
             if (request->bmRequestType_bit.direction == TUSB_DIR_IN && request->wLength == 4) {
                 // transmit from `saved_value`
                 return tud_control_xfer(rhport, request, &saved_value, 4);
             }
             break;
 
-        case 0x04:
+        case REQUEST_RESET_BUFFERS:
             if (request->bmRequestType_bit.direction == TUSB_DIR_OUT && request->wLength == 0) {
                 reset_buffers();
                 return tud_control_status(rhport, request);
             }
             break;
 
+        case REQUEST_GET_INTF_NUM:
+            if (request->bmRequestType_bit.direction == TUSB_DIR_IN && request->wLength == 1) {
+                uint8_t intf_num = request->wIndex & 0xff;
+                if (intf_num < 4) {
+                    // return inteface number
+                    return tud_control_xfer(rhport, request, &intf_num, 1);
+                }
+            }
+            break;
+
+#if CFG_WINUSB == OPT_WINUSB_MSOS20
         case MSOS_VENDOR_CODE:
             if (request->wIndex == 7) {
                 // Get Microsoft OS 2.0 compatible descriptor
@@ -205,6 +222,7 @@ bool tud_vendor_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_requ
                 return tud_control_xfer(rhport, request, (uint8_t*) desc_ms_os_20, total_len);
             }
             break;
+#endif
 
         default:
             break;

test-devices/composite-stm32/bin/bluepill-f103c8.bin

@@ -49,20 +49,17 @@ uint8_t const* tud_descriptor_device_cb(void) {
 
 // --- Configuration Descriptor ---
 
-enum {
-    INTF_CDC_COMM = 0,
-    INTF_CDC_DATA,
-    INTF_LOOPBACK,
-    INTF_NUM_TOTAL
-};
-
-#define CONFIG_TOTAL_LEN (TUD_CONFIG_DESC_LEN + TUD_CDC_DESC_LEN + 9 + 7 + 7)
+#define CONFIG_TOTAL_LEN (TUD_CONFIG_DESC_LEN + TUD_CDC_DESC_LEN + 8 + 9 + 9 + 7 + 7)
 
 uint8_t const desc_configuration[] = {
     // Config number, interface count, string index, total length, attribute, power in mA
     TUD_CONFIG_DESCRIPTOR(1, INTF_NUM_TOTAL, 0, CONFIG_TOTAL_LEN, 0x00, 500),
     // CDC interfaces
     TUD_CDC_DESCRIPTOR(INTF_CDC_COMM, 0, EP_CDC_COMM, 8, EP_CDC_DATA_RX, EP_CDC_DATA_TX, BULK_MAX_PACKET_SIZE),
+    // Interface association descriptor (IAD)
+    CUSTOM_VENDOR_INTERFACE_ASSOCIATION(INTF_LOOPBACK_CTRL, 2, 0x04),
+    // Echo interface (no endpoint, just control messages)
+    CUSTOM_VENDOR_INTERFACE(INTF_LOOPBACK_CTRL, 0),
     // Loopback interface
     CUSTOM_VENDOR_INTERFACE(INTF_LOOPBACK, 2),
     // Loopback endpoint OUT
@@ -82,6 +79,8 @@ uint8_t const* tud_descriptor_configuration_cb(uint8_t configuration_index) {
 
 // --- BOS Descriptor ---
 
+#if CFG_WINUSB == OPT_WINUSB_MSOS20
+
 #define BOS_TOTAL_LEN (TUD_BOS_DESC_LEN + TUD_BOS_MICROSOFT_OS_DESC_LEN)
 
 #define MS_OS_20_DESC_LEN  0xB2
@@ -108,7 +107,7 @@ uint8_t const desc_ms_os_20[] = {
     U16_TO_U8S_LE(0x0008), U16_TO_U8S_LE(MS_OS_20_SUBSET_HEADER_CONFIGURATION), 0, 0, U16_TO_U8S_LE(MS_OS_20_DESC_LEN-0x0A),
 
     // Function Subset header: length, type, first interface, reserved, subset length
-    U16_TO_U8S_LE(0x0008), U16_TO_U8S_LE(MS_OS_20_SUBSET_HEADER_FUNCTION), INTF_LOOPBACK, 0, U16_TO_U8S_LE(MS_OS_20_DESC_LEN-0x0A-0x08),
+    U16_TO_U8S_LE(0x0008), U16_TO_U8S_LE(MS_OS_20_SUBSET_HEADER_FUNCTION), INTF_LOOPBACK_CTRL, 0, U16_TO_U8S_LE(MS_OS_20_DESC_LEN-0x0A-0x08),
 
     // MS OS 2.0 Compatible ID descriptor: length, type, compatible ID, sub compatible ID
     U16_TO_U8S_LE(0x0014), U16_TO_U8S_LE(MS_OS_20_FEATURE_COMPATBLE_ID), 'W', 'I', 'N', 'U', 'S', 'B', 0x00, 0x00,
@@ -129,6 +128,7 @@ uint8_t const desc_ms_os_20[] = {
 
 TU_VERIFY_STATIC(sizeof(desc_ms_os_20) == MS_OS_20_DESC_LEN, "Incorrect size");
 
+#endif
 
 
 // --- String Descriptors ---
@@ -138,7 +138,8 @@ const char* const string_table[] = {
     0,                // 0 - supported languages (see below)
     "JavaDoesUSB",    // 1 - manufacturer
     "Composite",      // 2 - product
-    board_serial_num  // 3 - serial number
+    board_serial_num, // 3 - serial number
+    "Loopback IAD"    // 4 - interface association descriptor
 };
 
 

test-devices/composite-stm32/platformio.ini

@@ -13,6 +13,24 @@
 
 #include <stdint.h>
 
+#define OPT_WINUSB_NONE 0
+#define OPT_WINUSB_MSOS20 2
+
+#ifndef CFG_WINUSB
+#define CFG_WINUSB OPT_WINUSB_MSOS20
+#endif
+
+
+// interfaces
+enum {
+    INTF_CDC_COMM = 0,
+    INTF_CDC_DATA,
+    INTF_LOOPBACK_CTRL,
+    INTF_LOOPBACK,
+    INTF_NUM_TOTAL
+};
+
+
 #define INTR_MAX_PACKET_SIZE 16
 #define BULK_MAX_PACKET_SIZE 64
 
@@ -24,8 +42,11 @@
 #define EP_LOOPBACK_RX 0x01
 #define EP_LOOPBACK_TX 0x82
 
-#define MSOS_VENDOR_CODE 0x44
+#if CFG_WINUSB == OPT_WINUSB_MSOS20
 
+#define MSOS_VENDOR_CODE 0x44
 extern uint8_t const desc_ms_os_20[];
 
+#endif
+
 void usb_init_serial_num();