Fine-tune tests

Author: manuelbl

java-does-usb/src/main/java/net/codecrete/usb/USBDevice.java

@@ -216,6 +216,11 @@ public interface USBDevice {
      * <p>
      * This method can send data to bulk and interrupt endpoints.
      * </p>
+     * <p>
+     * If the sent data length is a multiple of the packet size, it is often
+     * required to send an additional zero-length packet (ZLP) for the device
+     * to actually process the data. This method will not do it automatically.
+     * </p>
      *
      * @param endpointNumber endpoint number (in the range between 1 and 127)
      * @param data           data to send
@@ -231,6 +236,11 @@ public interface USBDevice {
      * <p>
      * This method can send data to bulk and interrupt endpoints.
      * </p>
+     * <p>
+     * If the sent data length is a multiple of the packet size, it is often
+     * required to send an additional zero-length packet (ZLP) for the device
+     * to actually process the data. This method will not do it automatically.
+     * </p>
      *
      * @param endpointNumber the endpoint number (in the range between 1 and 127)
      * @param timeout        the timeout period, in milliseconds (0 for no timeout)

java-does-usb/src/main/java/net/codecrete/usb/common/EndpointInputStream.java

@@ -64,10 +64,14 @@ protected EndpointInputStream(USBDeviceImpl device, int endpointNumber, int buff
         arena = Arena.openShared();
 
         int packetSize = device.getEndpoint(USBDirection.IN, endpointNumber).packetSize();
-        int n = (int) Math.round(Math.sqrt((double) bufferSize / packetSize));
-        n = Math.min(Math.max(n, 4), 32); // 32 limits packet size to 16KB (for USB HS)
-        transferSize = n * packetSize;
-        int maxOutstandingTransfers = Math.max((bufferSize + transferSize / 2) / transferSize, 2);
+
+        // use between 4 and 32 packets per transfer (256B to 2KB for FS, 2KB to 16KB for HS)
+        int numPacketsPerTransfer = (int) Math.round(Math.sqrt((double) bufferSize / packetSize));
+        numPacketsPerTransfer = Math.min(Math.max(numPacketsPerTransfer, 4), 32);
+        transferSize = numPacketsPerTransfer * packetSize;
+
+        // use at least 2 outstanding transfers (3 in total)
+        int maxOutstandingTransfers = Math.max((bufferSize + transferSize / 2) / transferSize, 3);
 
         configureEndpoint();
 

java-does-usb/src/main/java/net/codecrete/usb/common/EndpointOutputStream.java

@@ -67,10 +67,14 @@ protected EndpointOutputStream(USBDeviceImpl device, int endpointNumber, int buf
         arena = Arena.openShared();
 
         packetSize = device.getEndpoint(USBDirection.OUT, endpointNumber).packetSize();
-        int n = (int) Math.round(Math.sqrt((double) bufferSize / packetSize));
-        n = Math.min(Math.max(n, 4), 32); // 32 limits packet size to 16KB (for USB HS)
-        transferSize = n * packetSize;
-        int maxOutstandingTransfers = Math.max((bufferSize + transferSize / 2) / transferSize, 2);
+
+        // use between 4 and 32 packets per transfer (256B to 2KB for FS, 2KB to 16KB for HS)
+        int numPacketsPerTransfer = (int) Math.round(Math.sqrt((double) bufferSize / packetSize));
+        numPacketsPerTransfer = Math.min(Math.max(numPacketsPerTransfer, 4), 32);
+        transferSize = numPacketsPerTransfer * packetSize;
+
+        // use at least 2 outstanding transfers (3 in total)
+        int maxOutstandingTransfers = Math.max((bufferSize + transferSize / 2) / transferSize, 3);
 
         configureEndpoint();
 

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

@@ -42,6 +42,7 @@ void transferWithZLP_succeeds() {
         var inEndpoint = testDevice.getEndpoint(USBDirection.IN, LOOPBACK_EP_IN);
         byte[] sampleData = generateRandomBytes(inEndpoint.packetSize(), 97333894);
         testDevice.transferOut(LOOPBACK_EP_OUT, sampleData);
+        testDevice.transferOut(LOOPBACK_EP_OUT, new byte[0]);
         byte[] data = testDevice.transferIn(LOOPBACK_EP_IN);
         assertArrayEquals(sampleData, data);
         data = testDevice.transferIn(LOOPBACK_EP_IN);

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

@@ -40,14 +40,16 @@ void bulkTransfer_doesNotTimeOut() {
     @Test
     @Timeout(value = 1, unit = TimeUnit.SECONDS)
     void bulkTransferOut_timesOut() {
-        // The test device has an internal buffer of about 500 bytes.
-        // So the first transfer should not time out.
+        // The test device has an internal buffer of about 2KB for full-speed
+        // and 16KB for high-speed. The first transfer should not time-out.
+        final int bufferSize = 32 * testDevice
+                .getEndpoint(USBDirection.OUT, LOOPBACK_EP_OUT).packetSize();
 
         byte[] data = generateRandomBytes(100, 9383073929L);
         testDevice.transferOut(LOOPBACK_EP_OUT, data, 200);
 
         assertThrows(USBTimeoutException.class, () -> {
-            for (int i = 0; i < 50; i++) {
+            for (int i = 0; i < bufferSize / data.length; i++) {
                 testDevice.transferOut(LOOPBACK_EP_OUT, data, 200);
             }
         });

test-devices/loopback-stm32/lib/tinyusb/dwc2/dcd_dwc2.c

@@ -222,6 +222,8 @@ static void edpt_schedule_packets(uint8_t rhport, uint8_t const epnum, uint8_t c
 {
   (void) rhport;
 
+  TU_ASSERT(epnum < DWC2_EP_MAX, );
+
   dwc2_regs_t * dwc2 = DWC2_REG(rhport);
 
   // EP0 is limited to one packet each xfer
@@ -743,6 +745,9 @@ bool dcd_edpt_xfer (uint8_t rhport, uint8_t ep_addr, uint8_t * buffer, uint16_t
   uint8_t const epnum = tu_edpt_number(ep_addr);
   uint8_t const dir   = tu_edpt_dir(ep_addr);
 
+  uint8_t const ep_count = _dwc2_controller[rhport].ep_count;
+  TU_ASSERT(epnum < ep_count);
+
   xfer_ctl_t * xfer = XFER_CTL_BASE(epnum, dir);
   xfer->buffer      = buffer;
   xfer->ff          = NULL;
@@ -783,6 +788,9 @@ bool dcd_edpt_xfer_fifo (uint8_t rhport, uint8_t ep_addr, tu_fifo_t * ff, uint16
   uint8_t const epnum = tu_edpt_number(ep_addr);
   uint8_t const dir   = tu_edpt_dir(ep_addr);
 
+  uint8_t const ep_count = _dwc2_controller[rhport].ep_count;
+  TU_ASSERT(epnum < ep_count);
+
   xfer_ctl_t * xfer = XFER_CTL_BASE(epnum, dir);
   xfer->buffer      = NULL;
   xfer->ff          = ff;
@@ -1024,6 +1032,9 @@ static void handle_rxflvl_irq(uint8_t rhport)
 
     case GRXSTS_PKTSTS_OUTRX:
     {
+      uint8_t const ep_count = _dwc2_controller[rhport].ep_count;
+      TU_ASSERT(epnum < ep_count, );
+      
       // Out packet received
       xfer_ctl_t *xfer = XFER_CTL_BASE(epnum, TUSB_DIR_OUT);
 
@@ -1288,7 +1299,7 @@ void dcd_int_handler(uint8_t rhport)
 
   if(int_status & GINTSTS_SOF)
   {
-    dwc2->gotgint = GINTSTS_SOF;
+    dwc2->gintsts = GINTSTS_SOF;
 
     if (_sof_en)
     {

test-devices/loopback-stm32/src/main.c

@@ -18,11 +18,19 @@
 #include "usb_descriptors.h"
 #include "vendor_custom.h"
 
+#if BOARD_TUD_MAX_SPEED == OPT_MODE_HIGH_SPEED
+  #define BUFFER_SIZE 16384
+#else
+  #define BUFFER_SIZE 2048
+#endif
+
 // FIFO buffer for loopback data
 tu_fifo_t loopback_fifo;
-uint8_t loopback_buffer[2048] __attribute__ ((aligned(4)));
+uint8_t loopback_buffer[BUFFER_SIZE] __attribute__ ((aligned(4)));
 
 uint16_t bulk_packet_size = 64;
+const int num_rx_packets = 2;
+const int num_tx_packets = 4;
 
 // buffer for echoed packet
 uint8_t echo_buffer[16];
@@ -81,7 +89,7 @@ void loopback_check_tx(void) {
     uint16_t n = tu_fifo_count(&loopback_fifo);
 
     if (n > 0 && !cust_vendor_is_transmitting(EP_LOOPBACK_TX)) {
-        uint16_t max_size = 2 * bulk_packet_size;
+        uint16_t max_size = num_tx_packets * bulk_packet_size;
         if (n > max_size)
             n = max_size;
 
@@ -93,8 +101,8 @@ void loopback_check_tx(void) {
 void loopback_check_rx(void) {
 
     uint16_t n = tu_fifo_remaining(&loopback_fifo);
-    if (n >= bulk_packet_size && !cust_vendor_is_receiving(EP_LOOPBACK_RX))
-        cust_vendor_prepare_recv_fifo(EP_LOOPBACK_RX, &loopback_fifo, bulk_packet_size);
+    if (n >= num_rx_packets * bulk_packet_size && !cust_vendor_is_receiving(EP_LOOPBACK_RX))
+        cust_vendor_prepare_recv_fifo(EP_LOOPBACK_RX, &loopback_fifo, num_rx_packets * bulk_packet_size);
 }
 
 

test-devices/loopback-stm32/src/vendor_custom.c

@@ -58,7 +58,7 @@ void cv_reset(uint8_t rhport) {
     // nothing to do
 }
 
-// Open interface is the descriptor matches this class
+// Open interface if the descriptor matches this class
 uint16_t cv_open(uint8_t rhport, tusb_desc_interface_t const * desc_intf, uint16_t max_len) {
 
     cv_num_eps_open = 0;
@@ -185,17 +185,15 @@ void cust_vendor_prepare_recv(uint8_t ep_addr, void* buf, uint32_t buf_len) {
 
     uint8_t const rhport = BOARD_TUD_RHPORT;
 
-    if (usbd_edpt_busy(rhport, ep_addr))
-        return;
+    TU_ASSERT(!usbd_edpt_busy(rhport, ep_addr), );
 
     usbd_edpt_xfer(rhport, ep_addr, buf, buf_len);
 }
 
 void cust_vendor_prepare_recv_fifo(uint8_t ep_addr, tu_fifo_t * fifo, uint32_t buf_len) {
     uint8_t const rhport = BOARD_TUD_RHPORT;
 
-    if (usbd_edpt_busy(rhport, ep_addr))
-        return;
+    TU_ASSERT(!usbd_edpt_busy(rhport, ep_addr), );
 
     usbd_edpt_xfer_fifo(rhport, ep_addr, fifo, buf_len);
 }
@@ -205,8 +203,7 @@ void cust_vendor_start_transmit(uint8_t ep_addr, void const * data, uint32_t dat
 
     uint8_t const rhport = BOARD_TUD_RHPORT;
 
-    if (usbd_edpt_busy(rhport, ep_addr))
-        return;
+    TU_ASSERT(!usbd_edpt_busy(rhport, ep_addr), );
 
     usbd_edpt_xfer(rhport, ep_addr, (void*) data, data_len);
 }
@@ -215,8 +212,7 @@ void cust_vendor_start_transmit_fifo(uint8_t ep_addr, tu_fifo_t * fifo, uint32_t
 
     uint8_t const rhport = BOARD_TUD_RHPORT;
 
-    if (usbd_edpt_busy(rhport, ep_addr))
-        return;
+    TU_ASSERT(!usbd_edpt_busy(rhport, ep_addr), );
 
     usbd_edpt_xfer_fifo(rhport, ep_addr, (void*) fifo, data_len);
 }