Windows: composite devices

Author: manuelbl

java-does-usb/jextract/windows/gen_win.cmd

@@ -13,16 +13,23 @@ call %JEXTRACT% --source --output ../../src/main/java ^
   --include-function DeviceIoControl ^
   --include-function GetLastError ^
   --include-function GetModuleHandleW ^
+  --include-function FormatMessageW ^
+  --include-function LocalFree ^
   --include-macro ERROR_SUCCESS ^
   --include-macro ERROR_NO_MORE_ITEMS ^
+  --include-macro ERROR_MORE_DATA ^
   --include-macro ERROR_INSUFFICIENT_BUFFER ^
+  --include-macro ERROR_FILE_NOT_FOUND ^
   --include-macro GENERIC_READ ^
   --include-macro GENERIC_WRITE ^
   --include-macro FILE_SHARE_READ ^
   --include-macro FILE_SHARE_WRITE ^
   --include-macro FILE_ATTRIBUTE_NORMAL ^
   --include-macro FILE_FLAG_OVERLAPPED ^
   --include-macro OPEN_EXISTING ^
+  --include-macro FORMAT_MESSAGE_ALLOCATE_BUFFER ^
+  --include-macro FORMAT_MESSAGE_FROM_SYSTEM ^
+  --include-macro FORMAT_MESSAGE_IGNORE_INSERTS ^
   --include-struct _GUID ^
   --include-typedef GUID ^
   windows_headers.h
@@ -42,6 +49,9 @@ call %JEXTRACT% --source --output ../../src/main/java ^
   --include-function SetupDiGetDeviceRegistryPropertyW ^
   --include-function SetupDiGetDevicePropertyW ^
   --include-function SetupDiOpenDeviceInterfaceW ^
+  --include-function SetupDiCreateDeviceInfoList ^
+  --include-function SetupDiOpenDeviceInfoW ^
+  --include-function SetupDiOpenDevRegKey ^
   --include-struct _SP_DEVINFO_DATA ^
   --include-typedef SP_DEVINFO_DATA ^
   --include-struct _SP_DEVICE_INTERFACE_DATA ^
@@ -53,6 +63,9 @@ call %JEXTRACT% --source --output ../../src/main/java ^
   --include-macro SPDRP_ADDRESS ^
   --include-macro DEVPROP_TYPE_UINT32 ^
   --include-macro DEVPROP_TYPE_STRING ^
+  --include-macro DEVPROP_TYPEMOD_LIST ^
+  --include-macro DICS_FLAG_GLOBAL ^
+  --include-macro DIREG_DEV ^
   windows_headers.h
 
 call %JEXTRACT% --source --output ../../src/main/java ^
@@ -113,4 +126,28 @@ call %JEXTRACT% --source --output ../../src/main/java ^
        --include-function WinUsb_ControlTransfer ^
        --include-function WinUsb_WritePipe ^
        --include-function WinUsb_ReadPipe ^
+       --include-function WinUsb_GetAssociatedInterface ^
+       windows_headers.h
+
+call %JEXTRACT% --source --output ../../src/main/java ^
+       -D _AMD64_ -D _M_AMD64=100 -D UNICODE -D _UNICODE ^
+       -I "%SDK_DIR%\um" ^
+       -I "%SDK_DIR%\shared" ^
+       -l Advapi32 ^
+       --header-class-name Advapi32 ^
+       --target-package net.codecrete.usb.windows.gen.advapi32 ^
+       --include-function RegQueryValueExW ^
+       --include-function RegCloseKey ^
+       --include-macro REG_MULTI_SZ ^
+       --include-macro KEY_READ ^
+       windows_headers.h
+
+call %JEXTRACT% --source --output ../../src/main/java ^
+       -D _AMD64_ -D _M_AMD64=100 -D UNICODE -D _UNICODE ^
+       -I "%SDK_DIR%\um" ^
+       -I "%SDK_DIR%\shared" ^
+       -l Ole32 ^
+       --header-class-name Ole32 ^
+       --target-package net.codecrete.usb.windows.gen.ole32 ^
+       --include-function CLSIDFromString ^
        windows_headers.h

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

@@ -153,6 +153,8 @@ protected USBInterfaceImpl getInterface(int interfaceNumber) {
      *
      * @param endpointNumber endpoint number (1 to 127)
      * @param direction      transfer direction
+     * @param transferType1  transfer type 1
+     * @param transferType2  transfer type 2 (or {@code null})
      * @return endpoint address
      */
     protected byte getEndpointAddress(int endpointNumber, USBDirection direction,
@@ -172,16 +174,69 @@ protected byte getEndpointAddress(int endpointNumber, USBDirection direction,
             }
         }
 
+        throwInvalidEndpointException(endpointNumber, direction, transferType1, transferType2);
+        return 0; // will never be reached
+    }
+
+    /**
+     * Checks if the specified endpoint is valid for communication and returns the endpoint.
+     *
+     * @param endpointNumber endpoint number (1 to 127)
+     * @param direction      transfer direction
+     * @param transferType1  transfer type 1
+     * @param transferType2  transfer type 2 (or {@code null})
+     * @return endpoint
+     */
+    protected EndpointInfo getEndpoint(int endpointNumber, USBDirection direction,
+                                       USBTransferType transferType1, USBTransferType transferType2) {
+
+        checkIsOpen();
+
+        if (endpointNumber >= 1 && endpointNumber <= 127) {
+            for (var intf : interfaces_) {
+                if (intf.isClaimed()) {
+                    for (var ep : intf.alternate().endpoints()) {
+                        if (ep.number() == endpointNumber && ep.direction() == direction
+                                && (ep.transferType() == transferType1 || ep.transferType() == transferType2))
+                            return new EndpointInfo(intf.number(), ep.number(),
+                                    (byte) (endpointNumber | (direction == USBDirection.IN ? 0x80 : 0)));
+                    }
+                }
+            }
+        }
+
+        throwInvalidEndpointException(endpointNumber, direction, transferType1, transferType2);
+        return null; // will never be reached
+    }
+
+    protected void throwInvalidEndpointException(int endpointNumber, USBDirection direction,
+                                                 USBTransferType transferType1, USBTransferType transferType2) {
         String transferTypeDesc;
         if (transferType2 == null)
             transferTypeDesc = transferType1.name();
         else
             transferTypeDesc = String.format("%s or %s", transferType1.name(), transferType2.name());
         throw new USBException(String.format("Endpoint number %d does not exist, is not part of a claimed interface " +
-                "or is not valid for %s transfer in %s direction", endpointNumber, transferTypeDesc,
+                        "or is not valid for %s transfer in %s direction", endpointNumber, transferTypeDesc,
                 direction.name()));
     }
 
+    protected int getInterfaceNumber(int endpointNumber) {
+        if (endpointNumber < 1 || endpointNumber > 127)
+            return -1;
+
+        for (var intf : interfaces_) {
+            if (intf.isClaimed()) {
+                for (var ep : intf.alternate().endpoints()) {
+                    if (ep.number() == endpointNumber)
+                        return intf.number();
+                }
+            }
+        }
+
+        return -1;
+    }
+
     @Override
     public abstract byte[] controlTransferIn(USBControlTransfer setup, int length);
 
@@ -214,4 +269,7 @@ public int hashCode() {
     public String toString() {
         return "VID: 0x" + String.format("%04x", vendorId_) + ", PID: 0x" + String.format("%04x", productId_) + ", " + "manufacturer: " + manufacturer_ + ", product: " + product_ + ", serial: " + serialNumber_ + ", ID: " + id_;
     }
+
+    public record EndpointInfo(int interfaceNumber, int endpointNumber, byte endpointAddress) {
+    }
 }

java-does-usb/src/main/java/net/codecrete/usb/windows/CompositeFunction.java

@@ -0,0 +1,81 @@
+//
+// Java Does USB
+// Copyright (c) 2022 Manuel Bleichenbacher
+// Licensed under MIT License
+// https://opensource.org/licenses/MIT
+//
+
+package net.codecrete.usb.windows;
+
+import java.lang.foreign.MemoryAddress;
+
+/**
+ * Describes the function of an interface of a composite USB device.
+ * <p>
+ * A composite USB device can have multiple functions, e.g. a mass
+ * storage function and a virtual serial port function. Each function
+ * will appear as a separate device in Window.
+ * </p>
+ * <p>
+ * A function consists of one or more interfaces. Functions with
+ * multiple interfaces must have consecutive interface numbers. The
+ * interfaces after the first one are called associated interfaces.
+ * </p>
+ * <p>
+ * On Windows, each function has a separate device path. Each device
+ * path must be opened and each interface must be opened.
+ * Furthermore, the first and the associated interfaces are
+ * treated differently.
+ * </p>
+ */
+public class CompositeFunction {
+    // TODO: implement associated interfaces
+
+    // TODO: implement devices without interfaces
+
+    private final int firstInterfaceNumber_;
+    private final int numInterfaces_;
+    private final String devicePath_;
+    private MemoryAddress deviceHandle_;
+    private MemoryAddress firstInterfaceHandle_;
+
+    /**
+     * Creates a new instance with a single interface.
+     *
+     * @param interfaceNumber the interface number
+     * @param devicePath      the device path
+     */
+    public CompositeFunction(int interfaceNumber, String devicePath) {
+        firstInterfaceNumber_ = interfaceNumber;
+        numInterfaces_ = 1;
+        devicePath_ = devicePath;
+    }
+
+    public int firstInterfaceNumber() {
+        return firstInterfaceNumber_;
+    }
+
+    public int numInterfaces() {
+        return numInterfaces_;
+    }
+
+    public String devicePath() {
+        return devicePath_;
+    }
+
+    public MemoryAddress deviceHandle() {
+        return deviceHandle_;
+    }
+
+    public void setDeviceHandle(MemoryAddress deviceHandle) {
+        deviceHandle_ = deviceHandle;
+    }
+
+    public MemoryAddress firstInterfaceHandle() {
+        return firstInterfaceHandle_;
+    }
+
+    public void setFirstInterfaceHandle(MemoryAddress firstInterfaceHandle) {
+        firstInterfaceHandle_ = firstInterfaceHandle;
+    }
+}