No VOLUME serial number needed. It gets changed by formatting the disk / usb drive. I am concerned about Hardware/manufacturer serial number that exist in HDDs and USB drives. The drive serial can be found by going into the command line, navigating to the drive, and executing dir. The volume serial number is found in the top two lines - use it without the dash. It is possible to override this behaviour to make the system ignore a device's serial number and treat all devices with matching VID and PID connected to the same USB port as if they were the same device. This is achieved by adding a REGBINARY value called IgnoreHWSerNum to the registry and setting it to 01.
- Usb Serial Controller Driver
- Find Usb Serial Number Registry Tool
- Find Usb Serial Number Registry Tool
Summary
- Registry keys that must be set by OEMs to define USB descriptors.
Applies to:
- Windows 10
Last updated:
- November 2015
OEMs must set several registry values to make sure that their device enumerates with the correct metadata when connected to a computer. These values specify device and configuration descriptors for the USB device-side drivers in Windows. OEMs that create and include their own interfaces must set additional registry values in order for their interfaces to be loaded and used.
Registry keys related to the device-side USB drivers are under:
HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFN
This topic describes settings for the preceding key and subkeys that define the device, configuration, and interface descriptors for the device.
USBFN registry key
Configuration information for the USB device are under:
HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFN
This table describes its subkeys. Some of them can be modified by OEMs. More information about the supported values for each subkey is provided in sections below.
| Subkey | Description |
|---|---|
| Alternates | This subkey contains additional subkeys that describe an interface that has one or more alternate settings. |
| Associations | This subkey defines Interface Association Descriptors (IADs). Each IAD allows multiple interfaces to be grouped into a single function. Each subkey represents a different IAD and OEMs can modify the values for those subkeys. |
| Default | This subkey contains default values that are used to describe device-specific settings such as the VID and PID. This is a Microsoft-owned subkey whose values are overridden by those in the parent key. |
| Configurations | This subkey contains additional subkeys that contain configuration descriptor values that are used during USB enumeration. For example, the standard test configuration might exist under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNConfigurationsTestConfig. |
| ConfigurationsDefault | This is a Microsoft-owned subkey. It contains values for the default configuration. The interfaces in the default configuration are added before the current configuration present when the IncludeDefaultCfg value is set to 1 under the HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFN key. |
| Interfaces | This subkey contains additional subkeys that describe specific interface descriptors. For example, the IP over USB interface may reside under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNInterfacesIpOverUsb. The name of the interface subkey is also used as the hardware ID of the USBFN child device for loading the USBFn class driver. In the IP over USB example, the hardware ID of the USBFN child device will be USBFNIpOverUsb. |
This table describes the values that OEMs can define in the HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFN key. Values that are not defined in this key assume the default values defined by Microsoft under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNDefault.
All OEMs must set the idVendor, idProduct, ManufacturerString, and ProductString values. OEMs that create and add their own interfaces must also set CurrentConfiguration to the name of the subkey under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNConfigurations that includes their interfaces in the InterfaceList.
| Value | Type | Owner | Description |
|---|---|---|---|
| IncludeDefaultCfg | REG_DWORD | OEM | Set to 1 when OEMs want to include the interfaces of the Default configuration such as IpOverUsb or MTP. |
| idVendor | REG_DWORD | OEM | The vendor identifier for the device descriptor that is sent to the host during enumeration. |
| idProduct | REG_DWORD | OEM | The product identifier for the device descriptor that is sent to the host during enumeration. |
| ManufacturerString | REG_SZ | OEM | The manufacturer string that is sent to the host to identify the manufacturer of the device. |
| ProductString | REG_SZ | OEM | A string that describes the device as a product. The default value is Windows 10 Mobile Device. This value is used as the display name of the device in the connected computer's user interface. OEMs should make sure that this value matches the value of the PhoneModelName value under the DeviceTargetingInfo subkey. |
| iSerialNumber | REG_DWORD | OEM | If this value is set to 0, then the device does not have a serial number. If this value is non-zero or does not exist, then the serial number is generated uniquely per device. |
| CurrentConfiguration | REG_SZ | OEM | This string must correspond to the name of a configuration subkey. This string determines which configuration to use to build a configuration descriptor for USB device enumeration. |
USBFNConfigurations registry key
This table describes the values that OEMs can define for subkeys under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNConfigurations. Each subkey represents a different USB configuration. If the OEM wants to create their own interface, the OEM must define a new configuration which contains the interfaces to be used. To do this, create a subkey under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNConfigurations that uses the name of the configuration and populate the subkey with the values in this table. Additionally, for the USB driver to use the new configuration, the CurrentConfiguration value (described in the preceding table) must be set to the name of the configuration subkey.
| Value | Type | Owner | Description |
|---|---|---|---|
| InterfaceList | REG_MULTI_SZ | OEM or Microsoft | Contains a list of interface names that correspond to interface subkeys under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNInterfaces, the IAD associations defined under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNAssociations, and the alternate interfaces defined under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNAlternates. Those keys determine the interfaces that are used to describe the composite configuration descriptor. If the IncludeDefaultCfg value under the HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFN key is set to 1, this list is appended to the Microsoft-owned default interface list to create the complete interface list that the device will use to enumerate. |
| MSOSCompatIdDescriptor | REG_BINARY | OEM or Microsoft | Optional. Defines an Extended Compat ID OS Feature Descriptor for the configuration. If the IncludeDefaultCfg value under the HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFN key is set to 1, the functions in this descriptor are appended to the functions and interfaces in the default configuration. |
USBFNInterfaces registry key
This table describes the values that OEMs can modify for subkeys under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNInterfaces.
Each subkey represents a different USB interface. To define an interface, create a subkey under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNInterfaces using the name of the interface, and populate it with the values in the table below. Additionally, an interface will only be included if the interface is part of the InterfaceList of the CurrentConfiguration.
| Value | Type | Owner | Description |
|---|---|---|---|
| InterfaceDescriptor | REG_BINARY | OEM or Microsoft | A binary representation of an interface descriptor to send to the host during USB enumeration. The bInterfaceNumber and iInterface values are automatically populated by the USB function stack after compiling a full configuration descriptor to avoid conflicts with other interface descriptors. |
| InterfaceGUID | REG_SZ | OEM or Microsoft | A GUID that uniquely identifies an interface on the bus. |
| InterfaceNumber | REG_DWORD | OEM or Microsoft | Optional. This value is used to assign a fixed interface number to a function. Interface numbers 0-1F are reserved for legacy functions, 20-3F are reserved for Microsoft, and 40-5F are reserved for use by OEMs. |
| MSOSExtendedPropertyDescriptor | REG_BINARY | OEM or Microsoft | Optional. Defines an Extended Property OS Feature Descriptor for the interface. |
USBFNAlternates registry key
The alternates subkey is used to define a single interface that has one or more alternate interfaces. This table describes the values that OEMs can modify for subkeys under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNAlternates.
Each subkey represents a different interface. To define an interface with alternate settings, create a subkey under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNAlternates by using the name of the interface, and populate it with the values in the table below.
| Value | Type | Owner | Description |
|---|---|---|---|
| InterfaceList | REG_MULTI_SZ | OEM or Microsoft | A list of two of more interface names that correspond to interfaces defined under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNInterfaces. That key collectively defines an interface with alternate settings. The first interface corresponds to alternate setting 0, the second interface corresponds to alternate setting 1, and so on. |
| InterfaceNumber | REG_DWORD | OEM or Microsoft | Optional. This value is used to assign a fixed interface number to a function. Interface numbers 0-1F are reserved for legacy functions, 20-3F are reserved for Microsoft, and 40-5F are reserved for use by OEMs. |
| MSOSExtendedPropertyDescriptor | REG_BINARY | OEM or Microsoft | Optional. Defines an Extended Property OS Feature Descriptor for the interface. |
USBFNAssociations registry key
OEMs can specify associations by defining Interface Association Descriptors (IADs). Each IAD allows multiple interfaces to be grouped into a single function. This table describes the values that OEMs can modify for subkeys under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNAssociations.
Each subkey represents a different IAD. To define an association, create a subkey under HKEY_LOCAL_MACHINESystemCurrentControlSetControlUSBFNAssociations by using the name of the IAD, and populate it with the values in the table below.
| Value | Type | Owner | Description |
|---|---|---|---|
| InterfaceList | REG_MULTI_SZ | OEM or Microsoft | A list of interfaces or alternate interfaces that are associated with a USB function. If the size of the list is less than 2, then the function driver stack fails to load. Other functions or interfaces continue to load. |
| bFunctionClass | REG_DWORD | OEM or Microsoft | The class code of the function, set to 02. |
| bFunctionSubClass | REG_DWORD | OEM or Microsoft | The subclass code of the function, set to 0d. |
| bFunctionProtocol | REG_DWORD | The protocol code of the function, set to 01. | |
| MSOSExtendedPropertyDescriptor | REG_BINARY | OEM or Microsoft | Optional. Defines an Extended Property OS Feature Descriptor for the interface. |
Use case: Enabling MirrorLink
MirrorLink is an interoperability standard that allows integration between mobile devices and car infotainment systems. The device must expose a USB CDC NCM interface to the MirrorLink client. As a Communications Device Class (CDC) device, it is required to describe the data interfaces by using either an Interface Association Descriptor (IAD) and/or a CDC Function Union Descriptor.
To enable MirrorLink connectivity on Windows 10 Mobile Device, OEM must make these changes to expose an IAD.
Create an association for the communication and data interfaces by using an Interface Association Descriptor (IAD) by setting registry values shown in the preceding table.
In addition to the registry settings, set this registry value to a non-zero value.
Value Type Owner Description MirrorLink REG_DWORD OEM or Microsoft A non-zero value indicates the interface supports MirrorLink. The USB function stack does not stall the MirrorLink USB command. Class-specific descriptors can be included in the interface descriptor set that is defined in the registry. The size field must be set in those descriptors so that USB function driver stack can parse them accurately.
Alternatively, a CDC Function Union Descriptor can also be defined as a Class-Specific Interface Descriptor; however, the interface numbers specified by the Union descriptor are static and are not be assigned by the USB function driver stack, and the presence of a Union descriptor does not cause the interfaces described by it to be associated with a single child PDO. An IAD is required for that association.
Related topics
USB device-side drivers in Windows
Developing Windows drivers for USB function controllers
- Tegra Family Settings
Serial port settings can be made for all available ports. The serial ports are mapped as follows:
- Serial1: FFUART
- Serial2: BTUART
- Serial3: STDUART
Registry keys to change the pin assignment of the serial signals, available in Image V3.4 beta 1 and onwards.
With this registry keys, you can define a GPIO for the different UART functions. But ensure that the GPIO also has the special functionality available. You find more information about the special functionality of the GPIOs in the PXA Datasheet, available in the respective product page.
If you set the value to -1, No GPIO is used.
By default none of theses keys are in the registry, hence all available GPIOs for all Serial ports are initialized by the driver. The GPIOs used are selected in order to match the Colibri Evaluation Board V2.1.
Naming Convention Overview
Stranded deep free download. For compatibility with other Colibri modules Toradex did not use the function names and order of the serial ports from NVidia. Have a look at the following table for the mapping information:
| Toradex Name | Old Toradex Name | Nvidia Name | Device Array Index | Default SW Configuration |
|---|---|---|---|---|
| UART_A | FF_UART | UART1 | 0x80 | Serial 1 / CoM1: |
| UART_B | BT_UART | UART4 | 0x81 | Serial 2 / CoM2: |
| UART_C | STD_UART | UART2 | 0x82 | Serial 3 / CoM3: |
| UART_D | - | UART3 | 0x83 | No set by default |
| UART_E | - | UART5 | 0x84 | No set by default |
Colibri Tegra Registry Settings
Serial port settings can be made for all available ports if not stated different.
Notes:
- More details about PinMuxConfig settings can be found here.
- A tool to calculate supported baud rates for T20 / T30 is available as an Excel sheet: tegra_uart_baudrates.xlsx
On the Vybrid-based modules three serial ports are configured by default: UARTA, UARTB, UARTC.Each port is configured under a registry key named: [HKLMDriversBuiltInUARTX]It is possible to enable two additional ports (with some limitations) by following the instruction in this article. The serial ports signals can be multiplexed to different pins, by default singnals for UARTA,UARTB and UARTC are configured to be compatible with the other modules of the Colibri family.Each pin can be configured using registry entries.
The value specified reference a pin number on the SO-DIMM connector. If you want to use the processor's GPIO pin numbers you can do that by adding 0x80000000 to the GPIO number. ex: 0x80000002 references GPIO 2.Different combinations are available for the pins, check VFxx pinmux detail for reference. Changing pinouts for UARTA, UARTB and UARTC may break compatiblity with other Colibri modules and existing carrier boards.
On the iMX6-based modules serial port pins can be configured using the generic approach described in this article:
Usb Serial Controller Driver
This is not needed if you plan to use the standard pinout for the default UARTS defined for Colibri and Apalis.
Find Usb Serial Number Registry Tool
On the iMX7-based modules serial port pins can be configured using the generic approach described in this article:
This is not needed if you plan to use the standard pinout for the default UARTS defined for Colibri and Apalis.
To enable MirrorLink connectivity on Windows 10 Mobile Device, OEM must make these changes to expose an IAD.
Create an association for the communication and data interfaces by using an Interface Association Descriptor (IAD) by setting registry values shown in the preceding table.
In addition to the registry settings, set this registry value to a non-zero value.
Value Type Owner Description MirrorLink REG_DWORD OEM or Microsoft A non-zero value indicates the interface supports MirrorLink. The USB function stack does not stall the MirrorLink USB command. Class-specific descriptors can be included in the interface descriptor set that is defined in the registry. The size field must be set in those descriptors so that USB function driver stack can parse them accurately.
Alternatively, a CDC Function Union Descriptor can also be defined as a Class-Specific Interface Descriptor; however, the interface numbers specified by the Union descriptor are static and are not be assigned by the USB function driver stack, and the presence of a Union descriptor does not cause the interfaces described by it to be associated with a single child PDO. An IAD is required for that association.
Related topics
USB device-side drivers in Windows
Developing Windows drivers for USB function controllers
- Tegra Family Settings
Serial port settings can be made for all available ports. The serial ports are mapped as follows:
- Serial1: FFUART
- Serial2: BTUART
- Serial3: STDUART
Registry keys to change the pin assignment of the serial signals, available in Image V3.4 beta 1 and onwards.
With this registry keys, you can define a GPIO for the different UART functions. But ensure that the GPIO also has the special functionality available. You find more information about the special functionality of the GPIOs in the PXA Datasheet, available in the respective product page.
If you set the value to -1, No GPIO is used.
By default none of theses keys are in the registry, hence all available GPIOs for all Serial ports are initialized by the driver. The GPIOs used are selected in order to match the Colibri Evaluation Board V2.1.
Naming Convention Overview
Stranded deep free download. For compatibility with other Colibri modules Toradex did not use the function names and order of the serial ports from NVidia. Have a look at the following table for the mapping information:
| Toradex Name | Old Toradex Name | Nvidia Name | Device Array Index | Default SW Configuration |
|---|---|---|---|---|
| UART_A | FF_UART | UART1 | 0x80 | Serial 1 / CoM1: |
| UART_B | BT_UART | UART4 | 0x81 | Serial 2 / CoM2: |
| UART_C | STD_UART | UART2 | 0x82 | Serial 3 / CoM3: |
| UART_D | - | UART3 | 0x83 | No set by default |
| UART_E | - | UART5 | 0x84 | No set by default |
Colibri Tegra Registry Settings
Serial port settings can be made for all available ports if not stated different.
Notes:
- More details about PinMuxConfig settings can be found here.
- A tool to calculate supported baud rates for T20 / T30 is available as an Excel sheet: tegra_uart_baudrates.xlsx
On the Vybrid-based modules three serial ports are configured by default: UARTA, UARTB, UARTC.Each port is configured under a registry key named: [HKLMDriversBuiltInUARTX]It is possible to enable two additional ports (with some limitations) by following the instruction in this article. The serial ports signals can be multiplexed to different pins, by default singnals for UARTA,UARTB and UARTC are configured to be compatible with the other modules of the Colibri family.Each pin can be configured using registry entries.
The value specified reference a pin number on the SO-DIMM connector. If you want to use the processor's GPIO pin numbers you can do that by adding 0x80000000 to the GPIO number. ex: 0x80000002 references GPIO 2.Different combinations are available for the pins, check VFxx pinmux detail for reference. Changing pinouts for UARTA, UARTB and UARTC may break compatiblity with other Colibri modules and existing carrier boards.
On the iMX6-based modules serial port pins can be configured using the generic approach described in this article:
Usb Serial Controller Driver
This is not needed if you plan to use the standard pinout for the default UARTS defined for Colibri and Apalis.
Find Usb Serial Number Registry Tool
On the iMX7-based modules serial port pins can be configured using the generic approach described in this article:
This is not needed if you plan to use the standard pinout for the default UARTS defined for Colibri and Apalis.
Find Usb Serial Number Registry Tool
DMA mode can be enabled for each UART:
