Assigning new PID with Espressif VID to TinyUSB stack with Arduino ESP32 Core

[James-4DSystems]

Board

ESP32-S3R8 SoC

Device Description

Custom products we are building, using the ESP32-S3R8 SoC

Hardware Configuration

Many things are connected, including display, IO Expander, RTC, RTP/CTP touch.
D+/D- are going to a USB-C connector.
Hardware is working nicely and we can program it from the Arduino IDE (both 1.x and 2.x) without any problems, using the USB-C as well as the UART in conjunction with RESET and GPIO0 etc.

Version

v2.0.9

IDE Name

Arduino IDE

Operating System

Windows 10 / 11

Flash frequency

80Mhz

PSRAM enabled

yes

Upload speed

921600

Description

Not a problem as such, looking for directions as to how to set the Espressif allocated PID (ref: https://github.com/espressif/usb-pids) alongside the Espressif VID, to the TinyUSB Stack, so our products are identified as our own, rather than using the standard 0x1001 PID, and our board showing up as random other products which also use the ESP32.
I have already made contact with Espressif Support, and they suggested I raise the issue with you on this Github directly.
Their email response:

[ESP]You can configure and build one of the following USB example. and you may learn How to build ESP-IDF example first. and then you can find the related options in menuconfig of ESP-IDF USB example:

BTW, if you still want to use Arduino, since arduino-esp32 is maintained by another espressif team, it would be helpful if you could raise the issue on arduino-esp32 github directly. Thanks for your understanding and cooperation.

Is it possible to set the PID of the TinyUSB via the Arduino ESP32 core, or do we have to go about figuring out how to use the IDF and do it that way?
We are looking for a solution to be able to do this in production of our products. We have not used the IDF directly before, we are only using the Arduino ESP32 core, currently v2.0.9

It has been suggested to trying things such as USB.PID(0x8999) to set it, however this does not work.
(ref: espressif/usb-pids#101)

Please can you detail if its possible to set the PID using the Arduino ESP32 core, as we just cannot find the information required to do this. If we need to do it via the IDF directly, please indicate this, so we can focus our efforts there instead.

Sketch

N/A

Debug Message

N/A

Other Steps to Reproduce

No response

I have checked existing issues, online documentation and the Troubleshooting Guide

• I confirm I have checked existing issues, online documentation and Troubleshooting guide.

[mrengineer7777]

If you are using menuconfig, then it's likely you are generating a new sdkconfig.h file. At the Arduino level the sdkconfig options are pre-set, as they are pre-compiled into the binary files. It's likely you'll need to convert your project to IDF (possibly with Arduino as IDF component) to set the PID.

@SuGlider Can you confirm PID is an sdkconfig option?

[me-no-dev]

The USB class itself has getters and setters for VID/PID: https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/USB.h#L50-L54

[James-4DSystems]

If you are using menuconfig, then it's likely you are generating a new sdkconfig.h file. At the Arduino level the sdkconfig options are pre-set, as they are pre-compiled into the binary files. It's likely you'll need to convert your project to IDF (possibly with Arduino as IDF component) to set the PID.

Any idea if there are any guides on how to do this type of thing? We are only using the Arduino core, not using menuconfig in the IDF at all. Really needing to find some guidance here.

The USB class itself has getters and setters for VID/PID: https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/USB.h#L50-L54

Does this relate to what we already tried, here:

It has been suggested to trying things such as USB.PID(0x8999) to set it, however this does not work.
(ref: espressif/usb-pids#101)

[lbernstone]

As mentioned in that issue, post some code and output from setting USB.PID. Note that you must set the VID/PID before you call USB.begin().

[James-4DSystems]

Sorry after a bit more playing, it worked simply using this:

However, as expected, in Device Manager now the Native USB shows up as a device without a driver.

I just used the next available one in the Espressif PID list as a test (will change once we know the process works and will reserve one for us)

What is the solution to this now, to get it to load the same driver as before (usbser.sys) but with a different set of VID/PID values, for Windows 10/11 ?

Is there any information available to show how this is done?

I found this repo (https://github.com/kutukvpavel/Esp32-Win7-VCP-drivers), which looks to do the right type of thing, but this is more for Windows 7. Is it the driver signing in windows 10/11 which stops this method working, and we would have to get this new INF file signed in order to make this work?

Is this the type of thing required?
https://learn.microsoft.com/en-us/windows-hardware/drivers/develop/signing-a-driver

Does anyone know how this process works?

Thanks

[James-4DSystems]

Does anyone have any information as to how to practically go about doing this?
Changing the PID seems possible, however it doesnt stick with subsequent program loads.
When it has stuck, drivers dont work as they are not keyed to the VID/PID combo in Windows.
How do you get around this?
What is the process we need to follow to make a viable product with a Espressif VID and customised PID, that is workable with drivers, and that sticks over subsequent program loads?
Do we have to apply the USB.h library and setting the PID in a header library, so it does it every single program load for our product? or by making a Variant folder and adding in a pins_arduino.h file with PID/VID set in there?
And if we do that, how do we make a windows (and other OS) driver that works?
I just cannot find any information from Espressif about this stuff...

[lbernstone]

How much do you understand about USB? This is not the correct place to ask for tutorials, and google know a lot about this. https://en.wikipedia.org/wiki/USB_human_interface_device_class

[James-4DSystems]

I am specifically asking for support for ESP32-S3 for changing VID/PID based on the Espressif VID/PID register, and the ESP32-Arduino core. Every time I contact Espressif, they point me back here.
Googling does not produce any results to describe how to change the VID/PID of an Espressif ESP32-S3 and get the drivers working for the new combination.
If you have information, please share it, as we have exhausted our searches and keep being pushed back here by Support.

[igrr]

how to change the VID/PID of an Espressif ESP32-S3

Please excuse if I misunderstood, but in #8299 (comment) you wrote that you have already figured this part out: calling PID and VID methods of USB class was necessary to set the VID and the PID.

get the drivers working for the new combination

This, I'm afraid, is a bit out of scope of Arduino-esp32 project. I'll give you a few pointers to get started:

1. If your device has one of the standard classes (such as CDC) and it has the class set correctly in the device descriptor, then Windows will automatically load the correct driver. See e.g. https://learn.microsoft.com/en-us/windows-hardware/drivers/usbcon/usb-driver-installation-based-on-compatible-ids
2. If you have a vendor-specific device which is only used by one application in the system, you can load the generic WinUSB driver instead of writing your own driver or an inf file. This requires adding Windows-specific USB descriptors to your device. See https://learn.microsoft.com/en-us/windows-hardware/drivers/usbcon/automatic-installation-of-winusb for more information.
3. Alternatively, you can create an .inf file and specify the driver which has to be loaded. You will also need to digitally sign the inf file. More information on Windows drivers and signing them can be found at https://learn.microsoft.com/en-us/windows-hardware/drivers/.

[James-4DSystems]

3. Alternatively, you can create an .inf file and specify the driver which has to be loaded. You will also need to digitally sign the inf file. More information on Windows drivers and signing them can be found at https://learn.microsoft.com/en-us/windows-hardware/drivers/.

Hi @igrr

Yes we have the VID and PID changed with the methods, which seems to only be for the current project loaded, but I think by making a board variant and setting it in the arduino_pins.h this gets around having to do that. So that is fine.

However when we change the VID / PID, Windows device manager does not know how to use it.
Looking at Device Manager and at the Details, Compatible ID's, the Class and SubClass are 00 I think.

How do you change it to 02 like your link in 1 suggests?
https://learn.microsoft.com/en-us/windows-hardware/drivers/usbcon/usb-driver-installation-based-on-compatible-ids

Using the methods for:
USB.usbClass(02);
USB.usbSubClass(02);

Did nothing to change what we have in the image

We did method 3, took an INF and added in our VID/PID detail, and digitally signed the driver, and installed it, but it still is not accepted, most likely as the Class and Subclass is still 00, which we dont know how you change...

It would seem in the ardino_pins.h for the variant, there is no obvious way to change it either...?

Hardware ID's changed to what we set in the sketch code though.

If you have any other suggestions, I would love to hear.

Much appreciated

[me-no-dev]

Can you please provide full USB init code that you are using. Device and all.