windows: UsbPortInfo: Provide the same info about Manufacturer and Product name as POSIX

[jcsxdev]

EDITED (2024-01-06): updated 2. Improvement request topic about a workaround using the winapi crate.
EDITED (2024-01-01): updated 2. Improvement request topic about a workaround using the windows crate.

1. Issue description
2. Improvement request
   • Workaround
3. Others

1. Issue description

On POSIX systems, the UsbPortInfo returns custom Manufacturer and Product name linked to iVendor and iProduct attributes from Device Descriptor. In contrast, in Windows:

• the Manufacturer name is obtained from the DEVPKEY_Device_Manufacturer property key; and
• the Product name is obtained from the DEVPKEY_Device_FriendlyName property key.

This is causing the following issue:

• The Manufacturer and Product name information obtained from Windows is completely different from POSIX. If this information is used for device detection, the code will not be portable.

2. Improvement request

In Windows, the information must be obtained via DeviceIoControl. In a similar way to the lswinusb – a Rust library for listing USB Descriptors on Windows.

Workaround

This is a workaround that was developed using the lswinsub project, but using the winapi crate instead of the windows or windows-sys crate:

• jcsxdev@df9d145

It can be tested using the iocontrol feature. Example:

• cargo run --features iocontrol --example list_ports

But it is not a solution developed by someone who has experience with Rust and the Win32 API. This needs to be reviewed and/ or rewritten by someone with more experience.

3. Others

Additional information:

1. The USBViewer program also uses DeviceIoControl:
   • https://github.com/microsoft/Windows-driver-samples/blob/main/usb/usbview/enum.c
2. Python module pySerial also faces the same problem:
   • Read bus reported name pyserial/pyserial#338
   • list_ports: store USB product string descriptor pyserial/pyserial#637
   • Windows: Get proper string description of usb serial port via DeviceIoControl. pyserial/pyserial#725

[sirhcel]

You are absolutely right. I would expect to get the same information on systems where the port enumeration returns anything at all.

Than you very much for pointing this out and your comprehensive research! My schedule is tight these days. But it looks like you are already working on implementing this and this looks good skimming through it. Awesome! :) Would you mind filing a PR when this works for you?

[jcsxdev]

Than you very much for pointing this out and your comprehensive research! My schedule is tight these days. But it looks like you are already working on implementing this and this looks good skimming through it. Awesome! :)

Thank you for the feedback.

Would you mind filing a PR when this works for you?

No problem. I will file a PR when I complete some tests.

Example:

• The tests I had performed worked under the following condition:

• But they failed under the following condition:

I have made new changes to the iocontrol feature to fix this issue, but they haven't been tested yet.